POST
/
bc
/
v1
/
events
/
event
/
conversation-usage
Conversation usage
curl --request POST \
  --url https://app.mindlytics.ai/bc/v1/events/event/conversation-usage \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-ID: <api-key>' \
  --data '{
  "session_id": "<string>",
  "timestamp": "<string>",
  "user_id": "<string>",
  "device_id": "<string>",
  "type": "track",
  "event": "Conversation Usage",
  "conversation_id": "<string>",
  "properties": {
    "model": "<string>",
    "prompt_tokens": 123,
    "completion_tokens": 123
  }
}'
[
  {
    "type": "start_session"
  }
]

Authorizations

​
Authorization
string
header
required

API Key for your organization

​
X-App-ID
string
header
required

Project ID

Body

application/json
​
session_id
string
required

A unique session ID generated by caller

​
type
enum<string>
required

The event that tracks an arbitray event

Available options:
track
​
event
enum<string>
required

The event that represents a usage in a conversation

Available options:
Conversation Usage
​
conversation_id
string
required

The ID of the conversation

​
properties
object
required

Properties of a usage event. Either model and tokens (cost will be calculated if model is known), or cost directly. Common models have costs that are provided by a service on the web. If you are using one of these models, you can provide the model name and the number of tokens in the prompt and completion, and the cost will be calculated for you.

​
timestamp
string

The timestamp of the event, defaults to "now" if not specified.

​
user_id
string

The unique ID of the user

​
device_id
string

The ID of the device, if applicable

Response

200 - application/json

Success

The events that were generated by the Mindlytics service as a result of this event.

​
type
enum<string>
required

The type of event being sent.

Available options:
start_session,
end_session,
identify,
alias,
track
​
{key}