Events

​

Schema introspection

• --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
• --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. project-id, not --project-id).

​

create

• event_type (string): Must be one of: chain, model, tool, session.
• inputs (object): Input data for the event.

• event_id (string, UUID): Unique identifier for the event.
• session_id (string, UUID): Session/trace identifier.
• parent_id (string, UUID): Parent event ID. Defaults to session_id.

• event_name (string): Name of the event. Defaults to "unknown".
• source (string): Source of the event (e.g. sdk-python). Defaults to "unknown".

• config (object): Configuration data (e.g. model parameters, prompt templates).
• outputs (object): Output data from the event.
• error (string or null): Error message if the event failed.
• children_ids (array of strings): IDs of child events.
• duration (number): Duration of the event in milliseconds.
• start_time (number): Unix timestamp in milliseconds for event start.
• end_time (number): Unix timestamp in milliseconds for event end.
• metadata (object): Additional metadata (e.g. token counts, cost).
• metrics (object): Custom metrics.
• feedback (object): Feedback data (e.g. ratings, ground truth).
• user_properties (object): User properties associated with the event.

​

Usage

honeyhive events create [options]

​

Options

​

Example response

{
  "event_id": "7f22137a-6911-4ed3-bc36-110f1dde6b66",
  "success": true
}

​

get

​

Usage

honeyhive events get [options]

​

Options

​

update

​

Usage

honeyhive events update [options]

​

Options

​

Example request

{
  "metadata": {
    "cost": 0.00008,
    "completion_tokens": 23,
    "prompt_tokens": 35,
    "total_tokens": 58
  },
  "feedback": {
    "rating": 5
  },
  "metrics": {
    "num_words": 2
  },
  "outputs": {
    "role": "assistant",
    "content": "Hello world"
  },
  "config": {
    "template": [
      {
        "role": "system",
        "content": "Hello, {{ name }}!"
      }
    ]
  },
  "user_properties": {
    "user_id": "691b1f94-d38c-4e92-b051-5e03fee9ff86"
  },
  "duration": 42
}

​

search

​

Usage

honeyhive events search [options]

​

Options

​

create-batch

• events (array of event objects): Each event must include event_type (one of chain, model, tool, session) and inputs.

• single_session (boolean): If true, all events share a single session created from session_properties. Defaults to false.
• session_properties (object): Session metadata used when single_session is true. May include session_name, start_time, metadata.

​

Usage

honeyhive events create-batch [options]

​

Options

​

Example response

{
  "event_ids": [
    "7f22137a-6911-4ed3-bc36-110f1dde6b66",
    "7f22137a-6911-4ed3-bc36-110f1dde6b67"
  ],
  "session_id": "caf77ace-3417-4da4-944d-f4a0688f3c23",
  "success": true
}