HoneyHive

Delete a chart [Data Plane, project API key] via DELETE /v1/charts/{chart_id}

Permanently delete a configuration by its unique identifier. [Data Plane, project API key] via DELETE /v1/configurations/{configId}

Permanently delete a datapoint by its unique identifier. [Data Plane, project API key] via DELETE /v1/datapoints/{datapoint_id}

Deprecated. Use `DELETE /v1/datasets/{dataset_id}` instead. [Data Plane, project API key] via DELETE /v1/datasets

Permanently delete a dataset by its unique identifier. [Data Plane, project API key] via DELETE /v1/datasets/{dataset_id}

Deprecated. Use `DELETE /v1/datasets/{dataset_id}/datapoints/{datapoint_id}` instead. [Data Plane, project API key] via DELETE /v1/datasets/{dataset_id}/{datapoint_id}

Remove a specific datapoint from a dataset. The datapoint itself is not deleted, only dereferenced from the dataset. [Data Plane, project API key] via DELETE /v1/datasets/{dataset_id}/datapoints/{datapoint_id}

Deprecated. Use `DELETE /v1/metrics/{metric_id}` instead. [Data Plane, project API key] via DELETE /v1/metrics

Delete a metric [Data Plane, project API key] via DELETE /v1/metrics/{metric_id}

Soft-delete an annotation queue by its unique identifier. [Data Plane, project API key] via DELETE /v1/queues/{queue_id}

Permanently delete an experiment run by its run ID. [Data Plane, project API key] via DELETE /v1/runs/{run_id}

Retrieve all charts in the current scope. [Data Plane, project API key] via GET /v1/charts

Retrieve a single chart by id. [Data Plane, project API key] via GET /v1/charts/{chart_id}

List configurations with optional filtering by name, environment, and tags. [Data Plane, project API key] via GET /v1/configurations

Retrieve datapoints, optionally filtered by a list of datapoint IDs or dataset name. [Data Plane, project API key] via GET /v1/datapoints

Get a single datapoint by its unique identifier. [Data Plane, project API key] via GET /v1/datapoints/{datapoint_id}

Retrieve datasets, optionally filtered by dataset ID or name. [Data Plane, project API key] via GET /v1/datasets

Retrieve a single event by its unique identifier. The event is fetched directly from S3/MinIO storage. [Data Plane, project API key] via GET /v1/events/{event_id}

Deprecated. Use `GET /v1/runs/{run_id}/schema` (single-run) or `GET /v1/runs/schema` (project-wide) instead. [Data Plane, project API key] via GET /v1/events/schema

List all metrics [Data Plane, project API key] via GET /v1/metrics

Retrieve all snapshot versions of the metric's definition, ordered oldest-first. Returns the full version history unpaginated. [Data Plane, project API key] via GET /v1/metrics/{metric_id}/versions

List annotation queues for the current project scope, optionally filtered by enabled status. [Data Plane, project API key] via GET /v1/queues

Retrieve a single annotation queue by its unique identifier. [Data Plane, project API key] via GET /v1/queues/{queue_id}

List experiment runs with optional filtering by dataset, status, name, date range, and specific run IDs. Results are paginated and sortable. [Data Plane, project API key] via GET /v1/runs

Compare metrics and results between two experiment runs [Data Plane, project API key] via GET /v1/runs/{new_run_id}/compare/{old_run_id}

Retrieve and compare events between two experiment runs for detailed analysis [Data Plane, project API key] via GET /v1/runs/{new_run_id}/compare/{old_run_id}/events

Deprecated. Use `GET /v1/runs/{new_run_id}/compare/{old_run_id}` instead. [Data Plane, project API key] via GET /v1/runs/{new_run_id}/compare-with/{old_run_id}

Retrieve the full details of a single experiment run by its run ID. [Data Plane, project API key] via GET /v1/runs/{run_id}

Retrieve event metrics from ClickHouse for a specific experiment run [Data Plane, project API key] via GET /v1/runs/{run_id}/metrics

Deprecated. Use `GET /v1/runs/{run_id}/summary` instead. [Data Plane, project API key] via GET /v1/runs/{run_id}/result

Retrieve the events schema (fields, datasets, mappings) for a single experiment run. [Data Plane, project API key] via GET /v1/runs/{run_id}/schema

Compute evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object. [Data Plane, project API key] via GET /v1/runs/{run_id}/summary

Deprecated. Use `GET /v1/runs/{new_run_id}/compare/{old_run_id}/events` instead. [Data Plane, project API key] via GET /v1/runs/compare/events

Retrieve the aggregated events schema (fields, datasets, mappings) across all experiment runs in the project. [Data Plane, project API key] via GET /v1/runs/schema

Deprecated. Use `POST /v1/events` instead. The legacy route wraps the event object under an `event` key; the v1 route accepts a bare event object. [Data Plane, project API key] via POST /events

Deprecated. Use `POST /v1/events/batch` instead. The legacy route accepts the deprecated `is_single_session` and `session` aliases and lets per-event objects carry the deprecated `project` field; the v1 route rejects all three at the SDK boundary. [Data Plane, project API key] via POST /events/batch

Deprecated. Use `POST /v1/events` with `event_type="model"` instead. The `ModelEvent` schema carries 14 field-level deprecations covering the model-specific fields the generic event route now expresses (`model`, `messages`, `response`, `provider`, `usage`, `cost`, `hyperparameters`, `template`, `template_inputs`, `tools`, `tool_choice`, `response_format`, `duration`, `error`), plus `project` inherited from `LegacyEvent`. The legacy route continues to serve traffic and remaps these fields into `inputs.*` / `outputs.*` before storage. [Data Plane, project API key] via POST /events/model

Deprecated. Use `POST /v1/events/batch` with `event_type="model"` on each event instead. Migration notes: the top-level array `model_events` becomes `events`; each element must explicitly set `event_type: "model"` (the legacy route sets this server-side); the deprecated top-level aliases `is_single_session` and `session` are not accepted by the v1 route (`PostEventBatchRequest` is `.strict()`); use `single_session` and `session_properties` instead. The legacy route continues to serve traffic and remaps the model-specific fields on each event (`model`, `messages`, `response`, `provider`, `usage`, `cost`, `hyperparameters`, `template`, `template_inputs`, `tools`, `tool_choice`, `response_format`, `duration`, `error`) into `inputs.*` / `outputs.*` before storage. [Data Plane, project API key] via POST /events/model/batch

Deprecated. Use `POST /v1/sessions/{session_id}/events/batch` instead. This route accepts trace events under either `logs` (deprecated) or `events`. Exactly one of the two MUST be present in a request: neither → 400, both → 400. [Data Plane, project API key] via POST /session/{session_id}/traces

Deprecated. Use `POST /v1/sessions` instead. The legacy route wraps the session object under a `session` key; the v1 route accepts a bare session object. [Data Plane, project API key] via POST /session/start

Create a new chart [Data Plane, project API key] via POST /v1/charts

Create a new LLM or pipeline configuration with provider, parameters, and environment settings. [Data Plane, project API key] via POST /v1/configurations

Create a single datapoint with inputs, history, ground truth, and metadata. [Data Plane, project API key] via POST /v1/datapoints

Create multiple datapoints from events using field mappings and optional filters. [Data Plane, project API key] via POST /v1/datapoints/batch

Create a new dataset with an optional name, description, and initial set of datapoint IDs. [Data Plane, project API key] via POST /v1/datasets

Add new datapoints to an existing dataset. Provide raw data objects and a field mapping that specifies which fields map to inputs, ground truth, and history. [Data Plane, project API key] via POST /v1/datasets/{dataset_id}/datapoints

Create a new event (span) within a session trace. The request body is a bare event object (no `event` wrapper). **Required properties:** - `event_type` (string): Must be one of: `chain`, `model`, `tool`, `session`. - `inputs` (object): Input data for the event. **Auto-generated properties** (provided by the server when omitted): - `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`. **Optional properties with defaults:** - `event_name` (string): Name of the event. Defaults to `"unknown"`. - `source` (string): Source of the event (e.g. `sdk-python`). Defaults to `"unknown"`. **Optional properties:** - `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. [Data Plane, project API key] via POST /v1/events

Create multiple events in a single request. When `single_session` is true, all events share the same session created from `session_properties`. **Required properties:** - `events` (array of event objects): Each event must include `event_type` (one of `chain`, `model`, `tool`, `session`) and `inputs`. **Optional properties:** - `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`. Unknown top-level fields and per-event fields are rejected at the SDK boundary; the legacy aliases `is_single_session`, `session`, and per-event `project` are no longer accepted. [Data Plane, project API key] via POST /v1/events/batch

Deprecated. Use `POST /v1/events/search` instead. [Data Plane, project API key] via POST /v1/events/export

Search events via POST with filtering and pagination. This is the primary method for retrieving events from HoneyHive. [Data Plane, project API key] via POST /v1/events/search

Create a new metric [Data Plane, project API key] via POST /v1/metrics

Snapshot the supplied metric definition as a new version. By default the version is created as a draft (`deployed: false`); set `deploy_immediately: true` to also make it the live version in the same transaction. [Data Plane, project API key] via POST /v1/metrics/{metric_id}/versions

Mark the named version as the live version for the metric, unmarking any previously deployed version. [Data Plane, project API key] via POST /v1/metrics/{metric_id}/versions/{version_name}/deploy

Execute a metric on a specific event [Data Plane, project API key] via POST /v1/metrics/run

Deprecated. Use `POST /v1/metrics/run` instead. [Data Plane, project API key] via POST /v1/metrics/run_metric

Create a new annotation queue with a name, optional description, filters, and an initial set of event IDs to add. [Data Plane, project API key] via POST /v1/queues

Create a new experiment run to track an evaluation against a dataset. [Data Plane, project API key] via POST /v1/runs

Start a new session. The request body is a bare session object (no `session` wrapper). The server creates a session event and returns it. **No required properties.** Every field has a server-side fallback. **Auto-generated properties** (provided by the server when omitted): - `session_id` (string, UUID): Server generates a UUIDv4 if omitted or if the supplied value is not a valid UUID. **Optional properties with defaults:** - `event_name` (string): Falls back to `session_name` when not provided; defaults to `"unknown"` if both are absent. - `source` (string): Defaults to `"unknown"`. **Optional properties:** - `session_name` (string): Display name for the session. - `start_time` (number): Session start time as Unix milliseconds. The session normalizer uses `getInt64()` which only accepts numeric types; if a string is passed, the server silently falls back to the current time. - `end_time` (number): Session end time as Unix milliseconds (same numeric-only caveat as `start_time`). - `duration` (number): Session duration in milliseconds. - `config` (object): Configuration associated with the session. - `inputs` (object): Input data for the session. - `outputs` (object): Output data from the session. - `metadata` (object): Arbitrary metadata. - `user_properties` (object): User properties. - `children_ids` (array of strings): IDs of child events. Idempotent on `session_id`: posting twice with the same `session_id` merges metadata/user_properties into the existing session and returns the existing event. [Data Plane, project API key] via POST /v1/sessions

Add a batch of events to an existing session. Each event in the batch is stored with `session_id` set from the URL path, overriding any `session_id` in the event body. Each event must include `event_type` (one of `chain`, `model`, `tool`, `session`) and `inputs`. Unknown top-level fields and unknown per-event fields are rejected. Events are processed sequentially. For higher-throughput ingestion across sessions, use `POST /v1/events/batch` instead. [Data Plane, project API key] via POST /v1/sessions/{session_id}/events/batch

Deprecated. Use `PUT /v1/events/{event_id}` instead. [Data Plane, project API key] via PUT /events

Update a chart's editable fields. Only fields included in the request body are modified. [Data Plane, project API key] via PUT /v1/charts/{chart_id}

Update an existing configuration's name, provider, parameters, environment, or tags. [Data Plane, project API key] via PUT /v1/configurations/{configId}

Update fields on an existing datapoint. Only the provided fields are modified. [Data Plane, project API key] via PUT /v1/datapoints/{datapoint_id}

Deprecated. Use `PUT /v1/datasets/{dataset_id}` instead. [Data Plane, project API key] via PUT /v1/datasets

Update a dataset's name, description, or list of datapoint IDs. [Data Plane, project API key] via PUT /v1/datasets/{dataset_id}

Update fields on an existing event. Only the provided fields are modified; omitted fields are left unchanged. Extra fields not listed below are accepted by the server but silently ignored. [Data Plane, project API key] via PUT /v1/events/{event_id}

Deprecated. Use `PUT /v1/metrics/{metric_id}` instead. [Data Plane, project API key] via PUT /v1/metrics

Update a metric's editable fields. Only fields included in the request body are modified. [Data Plane, project API key] via PUT /v1/metrics/{metric_id}

Update fields on an existing annotation queue. Supports updating name, description, filters, enabled status, and adding/removing events. [Data Plane, project API key] via PUT /v1/queues/{queue_id}

Update fields on an existing experiment run such as name, status, metadata, or results. [Data Plane, project API key] via PUT /v1/runs/{run_id}