HoneyHive AI Docs home page

Events

Create a batch of events

Session

POST
Start a new session
GET
Retrieve a session

Events

PUT
Update an event
POST
Create a new event
POST
Retrieve events based on filters
POST
Create a new model event
POST
Create a batch of events
POST
Create a batch of model events

Metrics

GET
Get all metrics
PUT
Update an existing metric
POST
Create a new metric
DEL
Delete a metric

Tools

GET
Retrieve a list of tools
PUT
Update an existing tool
POST
Create a new tool
DEL
Delete a tool

Datapoints

GET
Retrieve a list of datapoints
POST
Create a new datapoint
GET
Retrieve a specific datapoint
PUT
Update a specific datapoint
DEL
Delete a specific datapoint

Datasets

GET
Get datasets
PUT
Update a dataset
POST
Create a dataset
DEL
Delete a dataset
POST
Add datapoints to a dataset

Projects

GET
Get a list of projects
PUT
Update an existing project
POST
Create a new project
DEL
Delete a project

Experiments

GET
Get a list of evaluation runs
POST
Create a new evaluation run
GET
Get details of an evaluation run
PUT
Update an evaluation run
DEL
Delete an evaluation run
GET
Retrieve experiment result
GET
Retrieve experiment comparison

Configurations

GET
Retrieve a list of configurations
POST
Create a new configuration
PUT
Update an existing configuration
DEL
Delete a configuration

Events

Create a batch of events

Please refer to our instrumentation guide for detailed information

POST

events

batch

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

object

events

array

events

Required

array

is_single_session

boolean

is_single_session

boolean

Default is false. If true, all events will be associated with the same session

session_properties

object

session_properties

object

Add Example Value

session_name

string

session_name

string

Name of the session

source

string

source

string

Source of the session - production, staging, etc

session_id

string

session_id

string

Unique id of the session, if not set, it will be auto-generated

config

object

config

object

Associated configuration for the session

inputs

object

inputs

object

Input object passed to the session - user query, text blob, etc

outputs

object

outputs

object

Final output of the session - completion, chunks, etc

error

string

error

string

Any error description if session failed

user_properties

object

user_properties

object

Any user properties associated with the session

metrics

object

metrics

object

Any values computed over the output of the session

feedback

object

feedback

object

Any user feedback provided for the session output

metadata

object

metadata

object

Any system or application metadata associated with the session

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

events

object[]

required

events.project

string

required

Project associated with the event

events.source

string

required

Source of the event - production, staging, etc

events.event_name

string

required

Name of the event

events.event_type

enum<string>

required

Specify whether the event is of "model", "tool" or "chain" type

Available options:

model,

tool,

chain

events.event_id

string

Unique id of the event, if not set, it will be auto-generated

events.session_id

string

Unique id of the session associated with the event, if not set, it will be auto-generated

events.parent_id

string

Id of the parent event if nested

events.children_ids

string[]

Id of events that are nested within the event

events.config

object

required

Associated configuration JSON for the event - model name, vector index name, etc

events.inputs

object

required

Input JSON given to the event - prompt, chunks, etc

events.outputs

object

Final output JSON of the event

events.error

string

Any error description if event failed

events.start_time

number

UTC timestamp (in milliseconds) for the event start

events.end_time

integer

UTC timestamp (in milliseconds) for the event end

events.duration

number

required

How long the event took in milliseconds

events.metadata

object

Any system or application metadata associated with the event

events.feedback

object

Any user feedback provided for the event output

events.metrics

object

Any values computed over the output of the event

events.user_properties

object

Any user properties associated with the event

is_single_session

boolean

Default is false. If true, all events will be associated with the same session

session_properties

object

session_properties.session_name

string

Name of the session

session_properties.source

string

Source of the session - production, staging, etc

session_properties.session_id

string

Unique id of the session, if not set, it will be auto-generated

session_properties.config

object

Associated configuration for the session

session_properties.inputs

object

Input object passed to the session - user query, text blob, etc

session_properties.outputs

object

Final output of the session - completion, chunks, etc

session_properties.error

string

Any error description if session failed

session_properties.user_properties

object

Any user properties associated with the session

session_properties.metrics

object

Any values computed over the output of the session

session_properties.feedback

object

Any user feedback provided for the session output

session_properties.metadata

object

Any system or application metadata associated with the session

Response

200 - application/json

event_ids

string[]

session_id

string

success

boolean

Create a new model event Create a batch of model events

twitter linkedin