HoneyHive AI

Authorizations

Authorization

string

header

required

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

Body

application/json

events

object[]

required

events.config

object

required

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

events.duration

number

required

How long the event took in milliseconds

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.inputs

object

required

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

events.project

string

required

Project associated with the event

events.source

string

required

Source of the event - production, staging, etc

events.children_ids

string[]

Id of events that are nested within the event

events.end_time

integer

UTC timestamp (in milliseconds) for the event end

events.error

string

Any error description if event failed

events.event_id

string

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

events.feedback

object

Any user feedback provided for the event output

events.metadata

object

Any system or application metadata associated with the event

events.metrics

object

Any values computed over the output of the event

events.outputs

object

Final output JSON of the event

events.parent_id

string

Id of the parent event if nested

events.session_id

string

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

events.start_time

number

UTC timestamp (in milliseconds) for the event start

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.config

object

Associated configuration for the session

session_properties.error

string

Any error description if session failed

session_properties.feedback

object

Any user feedback provided for the session output

session_properties.inputs

object

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

session_properties.metadata

object

Any system or application metadata associated with the session

session_properties.metrics

object

Any values computed over the output of the session

session_properties.outputs

object

Final output of the session - completion, chunks, etc

session_properties.session_id

string

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

session_properties.session_name

string

Name of the session

session_properties.source

string

Source of the session - production, staging, etc

session_properties.user_properties

object

Any user properties associated with the session

Response

200 - application/json

event_ids

string[]

session_id

string

success

boolean