Getting started

Nebuly’s platform tracks two different types of events:

• User interactions: tracks user messages with the consequent AI system response. Interactions are the main building block in the Nebuly platform.
• Explicit user behaviour: tracks explicit user feedback, such as thumbs up/down, rating scores and frontend actions like copy and paste. All explicit user behaviour events are linked to a specific interaction.

​

Step 0: Get your API key

In order to start tracking your users, you first need to create a project in the Nebuly platform and get the associated API key. The API key will be used to authenticate your requests to the Nebuly platform.

​

Step 1: Send user interactions to the Nebuly platform

We offer four different ways to send user interactions to the Nebuly platform using our APIs:

• Send interaction with trace: send a user interaction with its generation trace. A generation trace is a list of chain steps that the AI agentic system performed before generating the response. This is the recommended way to send user interactions to the Nebuly platform since it provides the most comprehensive information.
• Send interaction: send a simple user interaction. This approach is suggested for simple non-agentic systems, where the response of the ai system is generated in a single call to the LLM, without using any external tools or resources.
• Send conversation: send the full conversation between the user and the AI system. This approach allows to send interactions (with their traces) in a single request. This endpoint is designed for sending data asynchronously in bulk once conversations are completed.
• SDKs: use our SDKs to track user interactions in your application.

We also allow users to update the sent interactions with new information. This is useful when you want to send more information about a user, but the data is not available as soon as the interaction is sent. This can be done using our Send tags endpoint.

​

Step 2: Send explicit user behaviour to the Nebuly platform

Once an interaction is generated, end-users can perform futher actions on the frontend, like copy and paste, or give an explicit feedback about the interaction. We offer two different ways to send these explicit user behaviours to the Nebuly platform:

• Send frontend actions via API: send explicit user feedback about an interaction or a frontend action, like copy and paste. This is suggested way to send user actions since it allows the highest flexibility.
• Track user behavior with the SDK: use our SDKs to track frontend user actions in your application.