openapi: 3.1.0 info: title: HoneyHive Data Plane API license: name: MIT url: https://opensource.org/licenses/MIT version: 1.17.0 servers: - url: https://api.dp1.us.honeyhive.ai tags: - name: Charts description: | Define and manage saved charts. Charts are visualizations that aggregate metrics over time with bucketing, filters, and groupings. - name: Configurations description: | Manage prompt configurations, i.e. model parameters, message templates, and response settings that can be versioned and deployed without code changes. - name: Data Plane Api Keys description: | Create fine-grained data plane API keys for a project from a provisioning flow, using an organization-rooted key that is permitted to create keys. - name: Datapoints description: | Manage individual records inside datasets, including batch creation and mapping to source events. - name: Datasets description: | Curate collections of datapoints used as test sets for evaluations and experiments. - name: Events description: | Read and write trace events. Events are the spans that capture every step of an AI application's execution. - name: Experiments description: | Run, retrieve, and compare evaluation runs to measure how prompt or configuration changes affect agent performance. - name: Ingestion Api Keys description: | Create ingestion API keys for a project from a provisioning flow, using an organization-rooted data plane key that is permitted to create keys. An ingestion key is the credential an application sends traces with. - name: Metric Versions description: | Snapshot, list, and deploy versions of a metric's definition so changes can be reviewed and rolled back without losing history. - name: Metrics description: | Define and run evaluators, i.e. automated quality checks that score traces against criteria like accuracy, safety, or correctness. - name: Queues description: | Manage annotation queues for human review of traces, turning expert feedback into labeled datasets. - name: Sessions description: | Group related trace events into sessions, the top-level container for a multi-step or multi-service AI interaction. paths: /session/start: post: summary: Start a new session (deprecated) operationId: startSessionLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true tags: - Sessions description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyStartSessionRequest' responses: '200': description: Session successfully started content: application/json: schema: $ref: '#/components/schemas/PostSessionStartResponse' /session/{session_id}/traces: post: summary: Add traces to a session (deprecated) operationId: addSessionTracesLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true tags: - Sessions description: | 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. parameters: - name: session_id in: path required: true schema: type: string description: Session ID to add traces to requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddSessionTracesRequest' responses: '200': description: Traces added successfully content: application/json: schema: $ref: '#/components/schemas/SessionTracesResponse' '400': description: | Bad request: both `logs` and `events` supplied, or neither, or invalid event payload. /v1/sessions: post: tags: - Sessions operationId: createSession security: - IngestionApiKey: [] x-cli-name: create x-ts-sdk-name: create summary: Start a new session description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartSessionRequest' responses: '200': description: Session successfully started content: application/json: schema: $ref: '#/components/schemas/PostSessionStartResponse' '400': description: Bad request (invalid session data) /v1/sessions/{session_id}/events/batch: post: tags: - Sessions operationId: createSessionEventBatch security: - IngestionApiKey: [] x-cli-name: create-event-batch x-ts-sdk-name: createEventBatch summary: Add a batch of events to a session description: | 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. parameters: - name: session_id in: path required: true schema: type: string format: uuid description: Session ID to add events to requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SessionEventBatchRequest' responses: '200': description: Events added successfully content: application/json: schema: $ref: '#/components/schemas/SessionTracesResponse' example: success: true '400': description: Bad request (invalid event data or missing required fields) '500': description: Events partially added /events: post: tags: - Events operationId: createEventLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Create a new event (deprecated) description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyPostEventRequest' responses: '200': description: Event created successfully content: application/json: schema: $ref: '#/components/schemas/PostEventResponse' example: event_id: 7f22137a-6911-4ed3-bc36-110f1dde6b66 success: true '400': description: Bad request (invalid event data or missing required fields) put: tags: - Events operationId: updateEventLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Update an event (deprecated) description: | Deprecated. Use `PUT /v1/events/{event_id}` instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyUpdateEventRequest' example: event_id: 7f22137a-6911-4ed3-bc36-110f1dde6b66 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 responses: '200': description: Event updated '400': description: Bad request /v1/events: post: tags: - Events operationId: createEvent security: - IngestionApiKey: [] x-cli-name: create x-ts-sdk-name: create summary: Create a new event description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostEventRequest' responses: '200': description: Event created successfully content: application/json: schema: $ref: '#/components/schemas/PostEventResponse' example: event_id: 7f22137a-6911-4ed3-bc36-110f1dde6b66 success: true '400': description: Bad request (invalid event data or missing required fields) /v1/events/{event_id}: get: tags: - Events operationId: getEventLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getEvent discriminator: project_id x-cli-name: get x-ts-sdk-name: get summary: Get an event by ID (deprecated) description: Deprecated. Use `GET /v1/projects/{project_id}/events/{event_id}` with a data plane API key instead. Retrieves a single event by its unique identifier. The event is fetched directly from S3/MinIO storage. parameters: - in: path name: event_id required: true schema: type: string format: uuid description: The unique identifier of the event to retrieve responses: '200': description: Event retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventResponse' '400': description: Bad request (invalid event_id) '404': description: Event not found put: tags: - Events operationId: updateEvent security: - IngestionApiKey: [] x-cli-name: update x-ts-sdk-name: update summary: Update an event description: | 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. parameters: - in: path name: event_id required: true schema: type: string format: uuid description: The unique identifier of the event to update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEventRequest' example: 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 responses: '200': description: Event updated '400': description: Bad request /v1/projects/{project_id}/events/{event_id}: get: tags: - Events operationId: getEvent security: - DataPlaneApiKey: [] x-cli-name: get x-ts-sdk-name: get summary: Get an event by ID description: | Retrieve a single event by its unique identifier. The event is fetched directly from S3/MinIO storage. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that owns the event - in: path name: event_id required: true schema: type: string format: uuid description: The unique identifier of the event to retrieve responses: '200': description: Event retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventResponse' '400': description: Bad request (invalid event_id) '404': description: Event not found /v1/events/export: post: tags: - Events operationId: exportEventsLegacy security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Export events based on filters (deprecated) description: | Deprecated. Use `POST /v1/events/search` instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyExportEventsRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportEventsResponse' /v1/events/search: post: tags: - Events operationId: searchEventsLegacy security: - BearerAuth: [] x-cli-name: search x-ts-sdk-name: search x-twin: op: searchEvents discriminator: project_id deprecated: true x-hidden: true summary: Retrieve events based on filters (deprecated) description: Deprecated. Use `POST /v1/projects/{project_id}/events/search` with a data plane API key instead. Searches events via POST with filtering and pagination. This is the primary method for retrieving events from HoneyHive. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchEventsRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportEventsResponse' /v1/projects/{project_id}/events/search: post: tags: - Events operationId: searchEvents security: - DataPlaneApiKey: [] x-cli-name: search x-ts-sdk-name: search summary: Retrieve events based on filters description: | Search events via POST with filtering and pagination. This is the primary method for retrieving events from HoneyHive. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project whose events to search requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchEventsRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportEventsResponse' /v1/events/batch: post: tags: - Events operationId: createEventBatch security: - IngestionApiKey: [] x-cli-name: create-batch x-ts-sdk-name: createBatch summary: Create a batch of events description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostEventBatchRequest' responses: '200': description: Events created content: application/json: schema: $ref: '#/components/schemas/PostEventBatchResponse' example: event_ids: - 7f22137a-6911-4ed3-bc36-110f1dde6b66 - 7f22137a-6911-4ed3-bc36-110f1dde6b67 session_id: caf77ace-3417-4da4-944d-f4a0688f3c23 success: true '400': description: Bad request (invalid event data or missing required fields) '500': description: Events partially created /events/model: post: tags: - Events operationId: createModelEventLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Create a new model event (deprecated) description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostModelEventRequest' responses: '200': description: Model event created content: application/json: schema: $ref: '#/components/schemas/PostEventResponse' example: event_id: 7f22137a-6911-4ed3-bc36-110f1dde6b66 success: true /events/batch: post: tags: - Events operationId: createEventBatchLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Create a batch of events (deprecated) description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyPostEventBatchRequest' responses: '200': description: Events created content: application/json: schema: $ref: '#/components/schemas/PostEventBatchResponse' example: event_ids: - 7f22137a-6911-4ed3-bc36-110f1dde6b66 - 7f22137a-6911-4ed3-bc36-110f1dde6b67 session_id: caf77ace-3417-4da4-944d-f4a0688f3c23 success: true '500': description: Events partially created /events/model/batch: post: tags: - Events operationId: createModelEventBatchLegacy security: - IngestionApiKey: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Create a batch of model events (deprecated) description: | 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostModelEventBatchRequest' responses: '200': description: Model events created content: application/json: schema: $ref: '#/components/schemas/PostEventBatchResponse' example: event_ids: - 7f22137a-6911-4ed3-bc36-110f1dde6b66 - 7f22137a-6911-4ed3-bc36-110f1dde6b67 success: true '500': description: Model events partially created /v1/charts: get: tags: - Charts operationId: getChartsLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getCharts discriminator: project_id x-cli-name: list x-ts-sdk-name: list summary: List charts (deprecated) description: Deprecated. Use `GET /v1/projects/{project_id}/charts` with a data plane API key instead. Retrieves all charts in the current scope. responses: '200': description: Charts retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetChartsResponse' post: tags: - Charts operationId: createChartLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: createChart discriminator: project_id x-cli-name: create x-ts-sdk-name: create summary: Create a new chart (deprecated) description: Deprecated. Use `POST /v1/projects/{project_id}/charts` with a data plane API key instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateChartRequest' responses: '200': description: Chart created successfully content: application/json: schema: $ref: '#/components/schemas/CreateChartResponse' /v1/charts/{chart_id}: get: tags: - Charts operationId: getChartLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getChart discriminator: project_id x-cli-name: get x-ts-sdk-name: get summary: Get a chart (deprecated) description: Deprecated. Use `GET /v1/projects/{project_id}/charts/{chart_id}` with a data plane API key instead. Retrieves a single chart by id. parameters: - in: path name: chart_id required: true schema: type: string description: The unique identifier of the chart to retrieve responses: '200': description: Chart retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetChartResponse' put: tags: - Charts operationId: updateChartLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: updateChart discriminator: project_id x-cli-name: update x-ts-sdk-name: update summary: Update a chart (deprecated) description: Deprecated. Use `PATCH /v1/projects/{project_id}/charts/{chart_id}` with a data plane API key instead. Updates a chart's editable fields. Only fields included in the request body are modified. parameters: - in: path name: chart_id required: true schema: type: string description: The unique identifier of the chart to update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateChartRequest' responses: '200': description: Chart updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateChartResponse' delete: tags: - Charts operationId: deleteChartLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: deleteChart discriminator: project_id x-cli-name: delete x-ts-sdk-name: delete summary: Delete a chart (deprecated) description: Deprecated. Use `DELETE /v1/projects/{project_id}/charts/{chart_id}` with a data plane API key instead. parameters: - in: path name: chart_id required: true schema: type: string description: The unique identifier of the chart to delete responses: '200': description: Chart deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteChartResponse' /v1/projects/{project_id}/charts: get: tags: - Charts operationId: getCharts security: - DataPlaneApiKey: [] x-cli-name: list x-ts-sdk-name: list summary: List charts description: Retrieve all charts in a project. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project whose charts are listed responses: '200': description: Charts retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetChartsResponse' post: tags: - Charts operationId: createChart security: - DataPlaneApiKey: [] x-cli-name: create x-ts-sdk-name: create summary: Create a new chart description: Create a chart in a project. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project the chart is created in requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateChartRequest' responses: '200': description: Chart created successfully content: application/json: schema: $ref: '#/components/schemas/CreateChartResponse' /v1/projects/{project_id}/charts/query: post: tags: - Charts operationId: queryChart security: - DataPlaneApiKey: [] x-cli-name: query x-ts-sdk-name: query summary: Run a chart query description: | Aggregate the project's events into one chart result. `query.kind` selects the result shape: time series, categorical, scalar, histogram, or table. Every query must include an `event_type is ` or `event_type is not ` filter; an `event_type is session` filter queries sessions instead of events. The `scatter` kind and a categorical `split_by` / `split_ranking` are accepted by the schema but not served yet, and answer 501. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project whose events are queried requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChartQueryRequest' responses: '200': description: Chart query result content: application/json: schema: $ref: '#/components/schemas/ChartQueryResponse' '400': description: The request is invalid or the query cannot be planned '422': description: The query exceeded its time or memory budget (`errorCode` `query_timeout` or `query_too_large`). Narrow the date range or add filters. '501': description: The query uses a shape that is not served yet (`scatter`, or a categorical `split_by` / `split_ranking`) /v1/projects/{project_id}/charts/{chart_id}: get: tags: - Charts operationId: getChart security: - DataPlaneApiKey: [] x-cli-name: get x-ts-sdk-name: get summary: Get a chart description: Retrieve a single chart by id. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the chart - in: path name: chart_id required: true schema: type: string description: The unique identifier of the chart to retrieve responses: '200': description: Chart retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetChartResponse' patch: tags: - Charts operationId: updateChart security: - DataPlaneApiKey: [] x-cli-name: update x-ts-sdk-name: update summary: Update a chart description: Update a chart's editable fields. Only fields included in the request body are modified. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the chart - in: path name: chart_id required: true schema: type: string description: The unique identifier of the chart to update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateChartRequest' responses: '200': description: Chart updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateChartResponse' delete: tags: - Charts operationId: deleteChart security: - DataPlaneApiKey: [] x-cli-name: delete x-ts-sdk-name: delete summary: Delete a chart description: Delete a chart from a project, removing it from the project's dashboards. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the chart - in: path name: chart_id required: true schema: type: string description: The unique identifier of the chart to delete responses: '200': description: Chart deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteChartResponse' /v1/projects/{project_id}/fine_grained_api_keys: post: tags: - Data Plane Api Keys operationId: createDataPlaneApiKey security: - DataPlaneApiKey: [] x-cli-name: create x-ts-sdk-name: create summary: Create a data plane API key description: "Create a fine-grained data plane API key rooted at a project. The caller's key must carry `project.fine_grained_api_key_dp.post` for the project. Only an organization-rooted key created in the organization's **Settings → API Keys**, on the **Data Plane** tab, can carry it, and a key created through this operation never can, so a provisioned key cannot create keys. The permissions requested are limited to the organization's data plane key policy, and `expires_at` to the system's maximum lifetime. The project must already exist on this data plane: a project created on the control plane reaches it asynchronously, and the operation answers 404 until it does. `key_value` is returned once and cannot be retrieved again." parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project the key is rooted at requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDataPlaneApiKeyRequest' responses: '200': description: Data plane API key created successfully content: application/json: schema: $ref: '#/components/schemas/CreateDataPlaneApiKeyResponse' /v1/projects/{project_id}/ingestion_api_keys: post: tags: - Ingestion Api Keys operationId: createIngestionApiKey security: - DataPlaneApiKey: [] x-cli-name: create x-ts-sdk-name: create summary: Create an ingestion API key description: "Create an ingestion API key for a project, the credential an application sends traces with. The caller's key must carry `project.ingestion_api_key.post` for the project. Only an organization-rooted data plane key created in the organization's **Settings → API Keys**, on the **Data Plane** tab, can carry it. An ingestion key has no permissions of its own and cannot create keys. The project must already exist on this data plane: a project created on the control plane reaches it asynchronously, and the operation answers 404 until it does. `key_value` is returned once and cannot be retrieved again." parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project the key belongs to requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateIngestionApiKeyRequest' responses: '200': description: Ingestion API key created successfully content: application/json: schema: $ref: '#/components/schemas/CreateIngestionApiKeyResponse' /v1/metrics: get: tags: - Metrics operationId: getMetrics security: - BearerAuth: [] x-cli-name: list x-ts-sdk-name: list summary: List all metrics parameters: - name: type in: query required: false schema: type: string description: Filter by metric type - name: id in: query required: false schema: type: string description: Filter by specific metric ID responses: '200': description: Metrics retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetMetricsResponse' post: tags: - Metrics operationId: createMetric security: - BearerAuth: [] x-cli-name: create x-ts-sdk-name: create summary: Create a new metric requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMetricRequest' responses: '200': description: Metric created successfully content: application/json: schema: $ref: '#/components/schemas/CreateMetricResponse' put: tags: - Metrics operationId: updateMetricLegacy security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Update an existing metric (deprecated) description: Deprecated. Use `PUT /v1/metrics/{metric_id}` instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyUpdateMetricRequest' responses: '200': description: Metric updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateMetricResponse' delete: tags: - Metrics operationId: deleteMetricLegacy security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Delete a metric (deprecated) description: Deprecated. Use `DELETE /v1/metrics/{metric_id}` instead. parameters: - name: metric_id in: query required: true schema: type: string description: Unique identifier of the metric responses: '200': description: Metric deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteMetricResponse' /v1/metrics/{metric_id}: put: tags: - Metrics operationId: updateMetric security: - BearerAuth: [] x-cli-name: update x-ts-sdk-name: update summary: Update an existing metric description: Update a metric's editable fields. Only fields included in the request body are modified. parameters: - in: path name: metric_id required: true schema: type: string description: The unique identifier of the metric to update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateMetricRequest' responses: '200': description: Metric updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateMetricResponse' delete: tags: - Metrics operationId: deleteMetric security: - BearerAuth: [] x-cli-name: delete x-ts-sdk-name: delete summary: Delete a metric parameters: - in: path name: metric_id required: true schema: type: string description: The unique identifier of the metric to delete responses: '200': description: Metric deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteMetricResponse' /v1/metrics/{metric_id}/versions: get: tags: - Metric Versions operationId: getMetricVersions security: - BearerAuth: [] x-cli-name: list x-ts-sdk-name: list summary: List versions for a metric description: Retrieve all snapshot versions of the metric's definition, ordered oldest-first. Returns the full version history unpaginated. parameters: - in: path name: metric_id required: true schema: type: string description: The unique identifier of the metric whose versions are being listed responses: '200': description: Metric versions retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetMetricVersionsResponse' '404': description: No metric with the given `metric_id` exists in the caller's scope. post: tags: - Metric Versions operationId: createMetricVersion security: - BearerAuth: [] x-cli-name: create x-ts-sdk-name: create summary: Create a new metric version description: '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.' parameters: - in: path name: metric_id required: true schema: type: string description: The unique identifier of the metric to version requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMetricVersionRequest' responses: '200': description: Metric version created successfully content: application/json: schema: $ref: '#/components/schemas/CreateMetricVersionResponse' '400': description: Invalid `content` payload. Fails cross-field validation (e.g. an `LLM` metric without `model_provider`/`model_name`). '404': description: No metric with the given `metric_id` exists in the caller's scope. /v1/metrics/{metric_id}/versions/{version_name}/deploy: post: tags: - Metric Versions operationId: deployMetricVersion security: - BearerAuth: [] x-cli-name: deploy x-ts-sdk-name: deploy summary: Deploy a specific metric version description: Mark the named version as the live version for the metric, unmarking any previously deployed version. parameters: - in: path name: metric_id required: true schema: type: string description: The unique identifier of the metric - in: path name: version_name required: true schema: type: string description: The name of the version to deploy responses: '200': description: Metric version deployed successfully content: application/json: schema: $ref: '#/components/schemas/DeployMetricVersionResponse' '404': description: No metric with the given `metric_id` exists in the caller's scope, or no version with the given `version_name` exists for that metric. /v1/metrics/run: post: tags: - Metrics operationId: runMetric security: - BearerAuth: [] x-cli-name: run x-ts-sdk-name: run summary: Run a metric evaluation description: Execute a metric on a specific event requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunMetricRequest' responses: '200': description: Metric evaluation succeeded content: application/json: schema: $ref: '#/components/schemas/RunMetricResponse' '400': description: Bad request. Either the request body failed validation (malformed metric or event), or the metric could not be evaluated because the request was deficient before any compute ran (the metric requires ground truth the event lacks, or the metric config is invalid). The error `message` describes the specific cause. '422': description: Could not process content. A compute request was dispatched but evaluation failed — e.g. the metric's code raised an error (`errorCode` `execution_error`, `compilation_error`) or the LLM evaluator's template/provider/response failed (`template_render_error`, `llm_response_parse_error`, ...). The error `message` carries the evaluator's detailed failure text. '500': description: Internal error while running the metric. /v1/metrics/run_metric: post: tags: - Metrics operationId: runMetricLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-cli-exclude: true x-ts-sdk-exclude: true summary: Run a metric evaluation (deprecated) description: Deprecated. Use `POST /v1/metrics/run` instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyRunMetricRequest' responses: '200': description: Metric evaluation succeeded content: application/json: schema: $ref: '#/components/schemas/RunMetricResponse' '400': description: Bad request. Either the request body failed validation (malformed metric or event), or the metric could not be evaluated because the request was deficient before any compute ran (missing ground truth, invalid metric config). The error `message` describes the specific cause. '422': description: Could not process content. A compute request was dispatched but evaluation failed (e.g. `execution_error`, `template_render_error`, `llm_response_parse_error`). '500': description: Internal error while running the metric. /v1/datapoints: get: summary: Retrieve a list of datapoints (deprecated) operationId: getDatapointsLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getDatapoints discriminator: project_id x-cli-name: list x-ts-sdk-name: list tags: - Datapoints description: Deprecated. Use `GET /v1/projects/{project_id}/datapoints` with a data plane API key instead. Retrieves datapoints, optionally filtered by a list of datapoint IDs or dataset name. parameters: - name: datapoint_ids in: query required: false schema: type: array items: type: string description: List of datapoint ids to fetch - name: dataset_name in: query required: false schema: type: string description: Name of the dataset to get datapoints from responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetDatapointsResponse' post: summary: Create a new datapoint (deprecated) operationId: createDatapointLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: createDatapoint discriminator: project_id x-cli-name: create x-ts-sdk-name: create tags: - Datapoints description: Deprecated. Use `POST /v1/projects/{project_id}/datapoints` with a data plane API key instead. Creates a single datapoint with inputs, history, ground truth, and metadata. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatapointRequest' responses: '200': description: Datapoint successfully created content: application/json: schema: $ref: '#/components/schemas/CreateDatapointResponse' /v1/datapoints/batch: post: summary: Create multiple datapoints in batch (deprecated) operationId: batchCreateDatapointsLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: batchCreateDatapoints discriminator: project_id x-cli-name: create-batch x-ts-sdk-name: createBatch tags: - Datapoints description: Deprecated. Use `POST /v1/projects/{project_id}/datapoints/batch` with a data plane API key instead. Creates multiple datapoints from events using field mappings and optional filters. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchCreateDatapointsRequest' responses: '200': description: Datapoints successfully created in batch content: application/json: schema: $ref: '#/components/schemas/BatchCreateDatapointsResponse' /v1/datapoints/{datapoint_id}: get: summary: Retrieve a specific datapoint (deprecated) operationId: getDatapointLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getDatapoint discriminator: project_id x-cli-name: get x-ts-sdk-name: get tags: - Datapoints description: Deprecated. Use `GET /v1/projects/{project_id}/datapoints/{datapoint_id}` with a data plane API key instead. Gets a single datapoint by its unique identifier. parameters: - name: datapoint_id in: path required: true schema: type: string description: Datapoint ID like `65c13dbbd65fb876b7886cdb` responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDatapointResponse' description: Successful response put: summary: Update a specific datapoint (deprecated) description: Deprecated. Use `PATCH /v1/projects/{project_id}/datapoints/{datapoint_id}` with a data plane API key instead. Updates fields on an existing datapoint. Only the provided fields are modified. parameters: - name: datapoint_id in: path required: true schema: type: string description: ID of datapoint to update operationId: updateDatapointLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: updateDatapoint discriminator: project_id x-cli-name: update x-ts-sdk-name: update tags: - Datapoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDatapointRequest' responses: '200': description: Datapoint successfully updated content: application/json: schema: $ref: '#/components/schemas/UpdateDatapointResponse' '400': description: Error updating datapoint delete: summary: Delete a specific datapoint (deprecated) operationId: deleteDatapointLegacy deprecated: true x-hidden: true x-twin: op: deleteDatapoint discriminator: project_id security: - BearerAuth: [] x-cli-name: delete x-ts-sdk-name: delete tags: - Datapoints description: Deprecated. Use `DELETE /v1/projects/{project_id}/datapoints/{datapoint_id}` with a data plane API key instead. Permanently deletes a datapoint by its unique identifier. parameters: - name: datapoint_id in: path required: true schema: type: string description: Datapoint ID like `65c13dbbd65fb876b7886cdb` responses: '200': description: Datapoint successfully deleted content: application/json: schema: $ref: '#/components/schemas/DeleteDatapointResponse' /v1/projects/{project_id}/datapoints: get: summary: Retrieve a list of datapoints operationId: getDatapoints security: - DataPlaneApiKey: [] x-cli-name: list x-ts-sdk-name: list tags: - Datapoints description: Retrieve datapoints, optionally filtered by a list of datapoint IDs or dataset name. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project whose datapoints are listed - name: datapoint_ids in: query required: false schema: type: array items: type: string description: List of datapoint ids to fetch - name: dataset_name in: query required: false schema: type: string description: Name of the dataset to get datapoints from responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetDatapointsResponse' post: summary: Create a new datapoint operationId: createDatapoint security: - DataPlaneApiKey: [] x-cli-name: create x-ts-sdk-name: create tags: - Datapoints description: Create a single datapoint with inputs, history, ground truth, and metadata. The `linked_datasets` array accepts at most one dataset ID. Requests with more than one entry return 400. A request with a non-empty `linked_datasets` also requires the `project.dataset.post` permission. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that owns the datapoint requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatapointRequest' responses: '200': description: Datapoint successfully created content: application/json: schema: $ref: '#/components/schemas/CreateDatapointResponse' /v1/projects/{project_id}/datapoints/batch: post: summary: Create multiple datapoints in batch operationId: batchCreateDatapoints security: - DataPlaneApiKey: [] x-cli-name: create-batch x-ts-sdk-name: createBatch tags: - Datapoints description: Create multiple datapoints from events using field mappings and optional filters. A data plane API key needs both `project.datapoint.post` and `project.event.get` for the project, and also `project.dataset.post` when the body names a `dataset_id`. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that owns the datapoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchCreateDatapointsRequest' responses: '200': description: Datapoints successfully created in batch content: application/json: schema: $ref: '#/components/schemas/BatchCreateDatapointsResponse' /v1/projects/{project_id}/datapoints/{datapoint_id}: get: summary: Retrieve a specific datapoint operationId: getDatapoint security: - DataPlaneApiKey: [] x-cli-name: get x-ts-sdk-name: get tags: - Datapoints description: Get a single datapoint by its unique identifier. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that owns the datapoint - name: datapoint_id in: path required: true schema: type: string description: Datapoint ID like `65c13dbbd65fb876b7886cdb` responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDatapointResponse' description: Successful response patch: summary: Update a specific datapoint description: Update fields on an existing datapoint. Only the provided fields are modified. A request that includes `linked_datasets` also requires the `project.dataset.post` and `project.dataset.delete` permissions. operationId: updateDatapoint security: - DataPlaneApiKey: [] x-cli-name: update x-ts-sdk-name: update tags: - Datapoints parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that owns the datapoint - name: datapoint_id in: path required: true schema: type: string description: ID of datapoint to update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDatapointRequest' responses: '200': description: Datapoint successfully updated content: application/json: schema: $ref: '#/components/schemas/UpdateDatapointResponse' '400': description: Error updating datapoint delete: summary: Delete a specific datapoint operationId: deleteDatapoint security: - DataPlaneApiKey: [] x-cli-name: delete x-ts-sdk-name: delete tags: - Datapoints description: Permanently delete a datapoint by its unique identifier, and remove it from every dataset that holds it. Answers 404 when the project holds no such datapoint. Requires only the `project.datapoint.delete` permission. parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that owns the datapoint - name: datapoint_id in: path required: true schema: type: string description: Datapoint ID like `65c13dbbd65fb876b7886cdb` responses: '200': description: Datapoint successfully deleted content: application/json: schema: $ref: '#/components/schemas/DeleteDatapointResponse' /v1/datasets: get: tags: - Datasets summary: Get datasets (deprecated) operationId: getDatasetsLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getDatasets discriminator: project_id x-cli-name: list x-ts-sdk-name: list description: Deprecated. Use `GET /v1/projects/{project_id}/datasets` with a data plane API key instead. Retrieves datasets, optionally filtered by dataset ID or name. parameters: - in: query name: dataset_id required: false schema: type: string description: Unique dataset ID for filtering specific dataset - in: query name: name required: false schema: type: string description: Dataset name to filter by responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetDatasetsResponse' post: tags: - Datasets operationId: createDatasetLegacy security: - BearerAuth: [] x-cli-name: create x-ts-sdk-name: create x-twin: op: createDataset discriminator: project_id deprecated: true x-hidden: true summary: Create a dataset (deprecated) description: Deprecated. Use `POST /v1/projects/{project_id}/datasets` with a data plane API key instead. Creates a new dataset with an optional name, description, and initial set of datapoint IDs. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRequest' responses: '200': description: Successful creation content: application/json: schema: $ref: '#/components/schemas/CreateDatasetResponse' put: tags: - Datasets operationId: updateDatasetBodyIdLegacy security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Update a dataset by body ID (deprecated) description: Deprecated. Use `PATCH /v1/projects/{project_id}/datasets/{dataset_id}` with a data plane API key instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LegacyUpdateDatasetRequest' responses: '200': description: Successful update content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetResponse' delete: tags: - Datasets operationId: deleteDatasetQueryIdLegacy security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true summary: Delete a dataset by query ID (deprecated) description: Deprecated. Use `DELETE /v1/projects/{project_id}/datasets/{dataset_id}` with a data plane API key instead. parameters: - in: query name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to be deleted like `663876ec4611c47f4970f0c3` responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetResponse' /v1/datasets/{dataset_id}: put: tags: - Datasets operationId: updateDatasetLegacy security: - BearerAuth: [] x-cli-name: update x-ts-sdk-name: update x-twin: op: updateDataset discriminator: project_id deprecated: true x-hidden: true summary: Update a dataset (deprecated) description: Deprecated. Use `PATCH /v1/projects/{project_id}/datasets/{dataset_id}` with a data plane API key instead. Updates a dataset's name, description, or list of datapoint IDs. parameters: - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to update like `663876ec4611c47f4970f0c3` requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRequest' responses: '200': description: Successful update content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetResponse' delete: tags: - Datasets operationId: deleteDatasetLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: deleteDataset discriminator: project_id x-cli-name: delete x-ts-sdk-name: delete summary: Delete a dataset (deprecated) description: Deprecated. Use `DELETE /v1/projects/{project_id}/datasets/{dataset_id}` with a data plane API key instead. Permanently deletes a dataset by its unique identifier. parameters: - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to be deleted like `663876ec4611c47f4970f0c3` responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetResponse' /v1/datasets/{dataset_id}/datapoints: post: tags: - Datasets summary: Add datapoints to a dataset (deprecated) operationId: addDatapointsLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: addDatapoints discriminator: project_id x-cli-name: add-datapoints x-ts-sdk-name: addDatapoints description: Deprecated. Use `POST /v1/projects/{project_id}/datasets/{dataset_id}/datapoints` with a data plane API key instead. Adds 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. parameters: - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to add datapoints to like `663876ec4611c47f4970f0c3` requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDatapointsToDatasetRequest' responses: '200': description: Successful addition content: application/json: schema: $ref: '#/components/schemas/AddDatapointsResponse' /v1/datasets/{dataset_id}/datapoints/{datapoint_id}: delete: tags: - Datasets summary: Remove a datapoint from a dataset (deprecated) operationId: removeDatapointLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: removeDatapoint discriminator: project_id x-cli-name: remove-datapoint x-ts-sdk-name: removeDatapoint description: Deprecated. Use `DELETE /v1/projects/{project_id}/datasets/{dataset_id}/datapoints/{datapoint_id}` with a data plane API key instead. Removes a specific datapoint from a dataset. The datapoint itself is not deleted, only dereferenced from the dataset. parameters: - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset - in: path name: datapoint_id required: true schema: type: string description: The unique identifier of the datapoint to remove responses: '200': description: Datapoint successfully removed from dataset content: application/json: schema: $ref: '#/components/schemas/RemoveDatapointResponse' /v1/datasets/{dataset_id}/{datapoint_id}: delete: tags: - Datasets summary: Remove a datapoint from a dataset by short path (deprecated) operationId: removeDatapointShortPathLegacy security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true description: Deprecated. Use `DELETE /v1/projects/{project_id}/datasets/{dataset_id}/datapoints/{datapoint_id}` with a data plane API key instead. parameters: - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset - in: path name: datapoint_id required: true schema: type: string description: The unique identifier of the datapoint to remove responses: '200': description: Datapoint successfully removed from dataset content: application/json: schema: $ref: '#/components/schemas/RemoveDatapointResponse' /v1/projects/{project_id}/datasets: get: tags: - Datasets summary: Get datasets operationId: getDatasets security: - DataPlaneApiKey: [] x-cli-name: list x-ts-sdk-name: list description: Retrieve datasets, optionally filtered by dataset ID or name. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project whose datasets are listed - in: query name: dataset_id required: false schema: type: string description: Unique dataset ID for filtering specific dataset - in: query name: name required: false schema: type: string description: Dataset name to filter by responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetDatasetsResponse' post: tags: - Datasets operationId: createDataset security: - DataPlaneApiKey: [] x-cli-name: create x-ts-sdk-name: create summary: Create a dataset description: Create a new dataset with an optional name, description, and initial set of datapoint IDs. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the dataset requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRequest' responses: '200': description: Successful creation content: application/json: schema: $ref: '#/components/schemas/CreateDatasetResponse' /v1/projects/{project_id}/datasets/{dataset_id}: patch: tags: - Datasets operationId: updateDataset security: - DataPlaneApiKey: [] x-cli-name: update x-ts-sdk-name: update summary: Update a dataset description: Update a dataset's name, description, or list of datapoint IDs. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the dataset - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to update like `663876ec4611c47f4970f0c3` requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRequest' responses: '200': description: Successful update content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetResponse' delete: tags: - Datasets operationId: deleteDataset security: - DataPlaneApiKey: [] x-cli-name: delete x-ts-sdk-name: delete summary: Delete a dataset description: Permanently delete a dataset by its unique identifier. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the dataset - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to be deleted like `663876ec4611c47f4970f0c3` responses: '200': description: Successful delete content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetResponse' /v1/projects/{project_id}/datasets/{dataset_id}/datapoints: post: tags: - Datasets summary: Add datapoints to a dataset operationId: addDatapoints security: - DataPlaneApiKey: [] x-cli-name: add-datapoints x-ts-sdk-name: addDatapoints description: 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. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the dataset - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset to add datapoints to like `663876ec4611c47f4970f0c3` requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDatapointsToDatasetRequest' responses: '200': description: Successful addition content: application/json: schema: $ref: '#/components/schemas/AddDatapointsResponse' /v1/projects/{project_id}/datasets/{dataset_id}/datapoints/{datapoint_id}: delete: tags: - Datasets summary: Remove a datapoint from a dataset operationId: removeDatapoint security: - DataPlaneApiKey: [] x-cli-name: remove-datapoint x-ts-sdk-name: removeDatapoint description: Remove a specific datapoint from a dataset. The datapoint itself is not deleted, only dereferenced from the dataset. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the dataset - in: path name: dataset_id required: true schema: type: string description: The unique identifier of the dataset - in: path name: datapoint_id required: true schema: type: string description: The unique identifier of the datapoint to remove responses: '200': description: Datapoint successfully removed from dataset content: application/json: schema: $ref: '#/components/schemas/RemoveDatapointResponse' /v1/events/schema: get: summary: Get events schema (deprecated) operationId: getEventsSchemaLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-cli-exclude: true x-ts-sdk-exclude: true tags: - Events description: Deprecated. Use `GET /v1/runs/{run_id}/schema` (single-run) or `GET /v1/runs/schema` (project-wide) instead. parameters: - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetEventsSchemaLegacyDateRangeOneOf1' description: Filter by date range - in: query name: evaluation_id required: false schema: type: string description: Filter by evaluation/run ID responses: '200': description: Events schema retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventsSchemaResponse' /v1/runs: post: summary: Create a new evaluation run (deprecated) operationId: createRunLegacy security: - BearerAuth: [] x-cli-name: create-run x-ts-sdk-name: createRun x-twin: op: createRun discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `POST /v1/projects/{project_id}/runs` with a data plane API key instead. Creates a new experiment run to track an evaluation against a dataset. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostExperimentRunRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PostExperimentRunResponse' '400': description: Invalid input get: summary: Get a list of evaluation runs (deprecated) operationId: getRunsLegacy security: - BearerAuth: [] x-cli-name: list-runs x-ts-sdk-name: listRuns x-twin: op: getRuns discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs` with a data plane API key instead. Lists experiment runs with optional filtering by dataset, status, name, date range, and specific run IDs. Results are paginated and sortable. parameters: - in: query name: dataset_id required: false schema: type: string description: Filter by dataset ID - in: query name: page required: false schema: type: integer minimum: 1 default: 1 description: Page number for pagination - in: query name: limit required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: Number of results per page - in: query name: run_ids required: false schema: type: array items: type: string description: List of specific run IDs to fetch - in: query name: name required: false schema: type: string description: Filter by run name - in: query name: status required: false schema: type: string enum: - pending - completed - failed - cancelled - running description: Filter by run status - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetRunsDateRangeOneOf1' description: Filter by date range - in: query name: sort_by required: false schema: type: string enum: - created_at - updated_at - name - status default: created_at description: Field to sort by - in: query name: sort_order required: false schema: type: string enum: - asc - desc default: desc description: Sort order responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunsResponse' '400': description: Error fetching evaluations /v1/runs/schema: get: summary: Get events schema across all experiment runs in a project (deprecated) operationId: getRunsSchemaLegacy security: - BearerAuth: [] x-cli-name: get-runs-schema x-ts-sdk-name: getRunsSchema x-twin: op: getRunsSchema discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/schema` with a data plane API key instead. Retrieves the aggregated events schema (fields, datasets, mappings) across all experiment runs in the project. parameters: - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetRunsSchemaDateRangeOneOf1' description: Filter by date range responses: '200': description: Events schema retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventsSchemaResponse' '400': description: Error fetching events schema /v1/runs/{run_id}: get: summary: Get details of an evaluation run (deprecated) operationId: getRunLegacy security: - BearerAuth: [] x-cli-name: get-run x-ts-sdk-name: getRun x-twin: op: getRun discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{run_id}` with a data plane API key instead. Retrieves the full details of a single experiment run by its run ID. parameters: - in: path name: run_id required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunResponse' '400': description: Error fetching evaluation put: summary: Update an evaluation run (deprecated) operationId: updateRunLegacy security: - BearerAuth: [] x-cli-name: update-run x-ts-sdk-name: updateRun x-twin: op: updateRun discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `PATCH /v1/projects/{project_id}/runs/{run_id}` with a data plane API key instead. Updates fields on an existing experiment run such as name, status, metadata, or results. parameters: - in: path name: run_id required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutExperimentRunRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PutExperimentRunResponse' '400': description: Invalid input delete: summary: Delete an evaluation run (deprecated) operationId: deleteRunLegacy security: - BearerAuth: [] x-cli-name: delete-run x-ts-sdk-name: deleteRun x-twin: op: deleteRun discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `DELETE /v1/projects/{project_id}/runs/{run_id}` with a data plane API key instead. Permanently deletes an experiment run by its run ID. parameters: - in: path name: run_id required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteExperimentRunResponse' '400': description: Error deleting evaluation /v1/runs/{run_id}/schema: get: summary: Get events schema for a single experiment run (deprecated) operationId: getRunSchemaLegacy security: - BearerAuth: [] x-cli-name: get-run-schema x-ts-sdk-name: getRunSchema x-twin: op: getRunSchema discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{run_id}/schema` with a data plane API key instead. Retrieves the events schema (fields, datasets, mappings) for a single experiment run. parameters: - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetRunSchemaDateRangeOneOf1' description: Filter by date range responses: '200': description: Events schema retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventsSchemaResponse' '400': description: Error fetching events schema /v1/runs/{run_id}/metrics: get: summary: Get event metrics for an experiment run (deprecated) operationId: getExperimentRunMetricsLegacy security: - BearerAuth: [] x-cli-name: get-run-metrics x-ts-sdk-name: getRunMetrics x-twin: op: getExperimentRunMetrics discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{run_id}/metrics` with a data plane API key instead. Retrieves event metrics from ClickHouse for a specific experiment run parameters: - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - name: dateRange in: query required: false schema: type: string description: Date range filter as JSON string - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Event metrics retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunMetricsResponse' '400': description: Error fetching event metrics /v1/runs/{run_id}/summary: get: summary: Retrieve experiment summary (deprecated) operationId: getExperimentSummaryLegacy security: - BearerAuth: [] x-cli-name: get-summary x-ts-sdk-name: getSummary x-twin: op: getExperimentSummary discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: 'Deprecated. Use `GET /v1/projects/{project_id}/runs/{run_id}/summary` with a data plane API key instead. Computes evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.' parameters: - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - name: aggregate_function in: query required: false schema: type: string enum: - average - min - max - median - p95 - p99 - p90 - sum - count default: average description: Aggregation function to apply to metrics - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Experiment summary retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunResultResponse' '400': description: Error processing experiment summary /v1/runs/{run_id}/result: get: summary: Retrieve experiment result (deprecated) operationId: getExperimentResultLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-cli-exclude: true x-ts-sdk-exclude: true tags: - Experiments description: Deprecated. Use `GET /v1/runs/{run_id}/summary` instead. parameters: - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - name: aggregate_function in: query required: false schema: type: string enum: - average - min - max - median - p95 - p99 - p90 - sum - count default: average description: Aggregation function to apply to metrics - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Experiment result retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunResultResponse' '400': description: Error processing experiment result /v1/runs/{new_run_id}/compare/{old_run_id}: get: summary: Retrieve experiment comparison (deprecated) operationId: getExperimentComparisonLegacy security: - BearerAuth: [] x-cli-name: compare-runs x-ts-sdk-name: compareRuns x-twin: op: getExperimentComparison discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{new_run_id}/compare/{old_run_id}` with a data plane API key instead. Compares metrics and results between two experiment runs. parameters: - name: new_run_id in: path required: true schema: type: string format: uuid description: New experiment run ID to compare (UUIDv4) - name: old_run_id in: path required: true schema: type: string format: uuid description: Old experiment run ID to compare against (UUIDv4) - name: aggregate_function in: query required: false schema: type: string enum: - average - min - max - median - p95 - p99 - p90 - sum - count default: average description: Aggregation function to apply to metrics - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Experiment comparison retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunCompareResponse' '400': description: Error processing experiment comparison /v1/projects/{project_id}/runs/{new_run_id}/compare/{old_run_id}: get: summary: Retrieve experiment comparison operationId: getExperimentComparison security: - DataPlaneApiKey: [] x-cli-name: compare-runs x-ts-sdk-name: compareRuns tags: - Experiments description: Compare metrics and results between two experiment runs in the project. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds both runs - name: new_run_id in: path required: true schema: type: string format: uuid description: New experiment run ID to compare (UUIDv4) - name: old_run_id in: path required: true schema: type: string format: uuid description: Old experiment run ID to compare against (UUIDv4) - name: aggregate_function in: query required: false schema: type: string enum: - average - min - max - median - p95 - p99 - p90 - sum - count default: average description: Aggregation function to apply to metrics - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Experiment comparison retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunCompareResponse' '400': description: Error processing experiment comparison /v1/runs/{new_run_id}/compare-with/{old_run_id}: get: summary: Retrieve experiment comparison via compare-with (deprecated) operationId: getExperimentComparisonCompareWithLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-cli-exclude: true x-ts-sdk-exclude: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{new_run_id}/compare/{old_run_id}` with a data plane API key instead. parameters: - name: new_run_id in: path required: true schema: type: string format: uuid description: New experiment run ID to compare (UUIDv4) - name: old_run_id in: path required: true schema: type: string format: uuid description: Old experiment run ID to compare against (UUIDv4) - name: aggregate_function in: query required: false schema: type: string description: Aggregation function to apply to metrics - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Experiment comparison retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunCompareResponse' '400': description: Error processing experiment comparison /v1/runs/{new_run_id}/compare/{old_run_id}/events: get: summary: Compare events between two experiment runs (deprecated) operationId: getExperimentCompareEventsLegacy security: - BearerAuth: [] x-cli-name: compare-run-events x-ts-sdk-name: compareRunEvents x-twin: op: getExperimentCompareEvents discriminator: project_id deprecated: true x-hidden: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{new_run_id}/compare/{old_run_id}/events` with a data plane API key instead. Retrieves and compares events between two experiment runs for detailed analysis parameters: - name: new_run_id in: path required: true schema: type: string format: uuid description: New experiment run ID (UUIDv4) - name: old_run_id in: path required: true schema: type: string format: uuid description: Old experiment run ID to compare against (UUIDv4) - name: event_name in: query required: false schema: type: string description: Filter by event name - name: event_type in: query required: false schema: type: string description: Filter by event type - name: filter in: query required: false schema: oneOf: - type: string - type: object description: Additional filter criteria (JSON string or object) - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: Maximum number of results - name: page in: query required: false schema: type: integer minimum: 1 default: 1 description: Page number for pagination responses: '200': description: Event comparison retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentCompareEventsResponse' '400': description: Error fetching event comparison /v1/runs/compare/events: get: summary: Compare events between two experiment runs by query IDs (deprecated) operationId: getExperimentCompareEventsQueryIdLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-cli-exclude: true x-ts-sdk-exclude: true tags: - Experiments description: Deprecated. Use `GET /v1/projects/{project_id}/runs/{new_run_id}/compare/{old_run_id}/events` with a data plane API key instead. parameters: - name: run_id_1 in: query required: true schema: type: string format: uuid description: First experiment run ID (UUIDv4) - name: run_id_2 in: query required: true schema: type: string format: uuid description: Second experiment run ID (UUIDv4) - name: event_name in: query required: false schema: type: string description: Filter by event name - name: event_type in: query required: false schema: type: string description: Filter by event type - name: filter in: query required: false schema: oneOf: - type: string - type: object description: Additional filter criteria (JSON string or object) - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: Maximum number of results - name: page in: query required: false schema: type: integer minimum: 1 default: 1 description: Page number for pagination responses: '200': description: Event comparison retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentCompareEventsResponse' '400': description: Error fetching event comparison /v1/projects/{project_id}/runs: get: summary: Get a list of evaluation runs operationId: getRuns security: - DataPlaneApiKey: [] x-cli-name: list-runs x-ts-sdk-name: listRuns tags: - Experiments description: List experiment runs with optional filtering by dataset, status, name, date range, and specific run IDs. Results are paginated and sortable. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project whose runs are listed - in: query name: dataset_id required: false schema: type: string description: Filter by dataset ID - in: query name: page required: false schema: type: integer minimum: 1 default: 1 description: Page number for pagination - in: query name: limit required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: Number of results per page - in: query name: run_ids required: false schema: type: array items: type: string description: List of specific run IDs to fetch - in: query name: name required: false schema: type: string description: Filter by run name - in: query name: status required: false schema: type: string enum: - pending - completed - failed - cancelled - running description: Filter by run status - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetRunsDateRangeOneOf1' description: Filter by date range - in: query name: sort_by required: false schema: type: string enum: - created_at - updated_at - name - status default: created_at description: Field to sort by - in: query name: sort_order required: false schema: type: string enum: - asc - desc default: desc description: Sort order responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunsResponse' '400': description: Error fetching evaluations post: summary: Create a new evaluation run operationId: createRun security: - DataPlaneApiKey: [] x-cli-name: create-run x-ts-sdk-name: createRun tags: - Experiments description: Create a new experiment run to track an evaluation against a dataset. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the run requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostExperimentRunRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PostExperimentRunResponse' '400': description: Invalid input /v1/projects/{project_id}/runs/schema: get: summary: Get events schema across all experiment runs in a project operationId: getRunsSchema security: - DataPlaneApiKey: [] x-cli-name: get-runs-schema x-ts-sdk-name: getRunsSchema tags: - Experiments description: Retrieve the aggregated events schema (fields, datasets, mappings) across all experiment runs in the project. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project whose runs the schema covers - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetRunsSchemaDateRangeOneOf1' description: Filter by date range responses: '200': description: Events schema retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventsSchemaResponse' '400': description: Error fetching events schema /v1/projects/{project_id}/runs/{run_id}: get: summary: Get details of an evaluation run operationId: getRun security: - DataPlaneApiKey: [] x-cli-name: get-run x-ts-sdk-name: getRun tags: - Experiments description: Retrieve the full details of a single experiment run by its run ID. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the run - in: path name: run_id required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunResponse' '400': description: Error fetching evaluation patch: summary: Update an evaluation run operationId: updateRun security: - DataPlaneApiKey: [] x-cli-name: update-run x-ts-sdk-name: updateRun tags: - Experiments description: Update fields on an existing experiment run such as name, status, metadata, or results. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the run - in: path name: run_id required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutExperimentRunRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PutExperimentRunResponse' '400': description: Invalid input delete: summary: Delete an evaluation run operationId: deleteRun security: - DataPlaneApiKey: [] x-cli-name: delete-run x-ts-sdk-name: deleteRun tags: - Experiments description: Permanently delete an experiment run by its run ID. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that owns the run - in: path name: run_id required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteExperimentRunResponse' '400': description: Error deleting evaluation /v1/projects/{project_id}/runs/{run_id}/schema: get: summary: Get events schema for a single experiment run operationId: getRunSchema security: - DataPlaneApiKey: [] x-cli-name: get-run-schema x-ts-sdk-name: getRunSchema tags: - Experiments description: Retrieve the events schema (fields, datasets, mappings) for a single experiment run. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds the run - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - in: query name: dateRange required: false schema: oneOf: - type: string - $ref: '#/components/schemas/GetRunSchemaDateRangeOneOf1' description: Filter by date range responses: '200': description: Events schema retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEventsSchemaResponse' '400': description: Error fetching events schema /v1/projects/{project_id}/runs/{run_id}/summary: get: summary: Retrieve experiment summary operationId: getExperimentSummary security: - DataPlaneApiKey: [] x-cli-name: get-summary x-ts-sdk-name: getSummary tags: - Experiments description: 'Compute evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.' parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds the experiment run - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - name: aggregate_function in: query required: false schema: type: string enum: - average - min - max - median - p95 - p99 - p90 - sum - count default: average description: Aggregation function to apply to metrics - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Experiment summary retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunResultResponse' '400': description: Error processing experiment summary /v1/projects/{project_id}/runs/{run_id}/metrics: get: summary: Get event metrics for an experiment run operationId: getExperimentRunMetrics security: - DataPlaneApiKey: [] x-cli-name: get-run-metrics x-ts-sdk-name: getRunMetrics tags: - Experiments description: Retrieve event metrics from ClickHouse for a specific experiment run parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds the run - name: run_id in: path required: true schema: type: string format: uuid description: Experiment run ID (UUIDv4) - name: dateRange in: query required: false schema: type: string description: Date range filter as JSON string - name: filters in: query required: false schema: oneOf: - type: string - type: array items: type: object description: Optional filters to apply (JSON string or array of filter objects) responses: '200': description: Event metrics retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentRunMetricsResponse' '400': description: Error fetching event metrics /v1/projects/{project_id}/runs/{new_run_id}/compare/{old_run_id}/events: get: summary: Compare events between two experiment runs operationId: getExperimentCompareEvents security: - DataPlaneApiKey: [] x-cli-name: compare-run-events x-ts-sdk-name: compareRunEvents tags: - Experiments description: Retrieve and compare events between two experiment runs for detailed analysis parameters: - name: project_id in: path required: true schema: type: string description: The unique identifier of the project that holds both runs - name: new_run_id in: path required: true schema: type: string format: uuid description: New experiment run ID (UUIDv4) - name: old_run_id in: path required: true schema: type: string format: uuid description: Old experiment run ID to compare against (UUIDv4) - name: event_name in: query required: false schema: type: string description: Filter by event name - name: event_type in: query required: false schema: type: string description: Filter by event type - name: filter in: query required: false schema: oneOf: - type: string - type: object description: Additional filter criteria (JSON string or object) - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: Maximum number of results - name: page in: query required: false schema: type: integer minimum: 1 default: 1 description: Page number for pagination responses: '200': description: Event comparison retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetExperimentCompareEventsResponse' '400': description: Error fetching event comparison /v1/queues: get: tags: - Queues operationId: getQueuesLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getQueues discriminator: project_id x-ts-sdk-exclude: true x-cli-exclude: true summary: List annotation queues (deprecated) description: Deprecated. Use `GET /v1/projects/{project_id}/queues` with a data plane API key instead. Lists annotation queues for the current project scope, optionally filtered by enabled status. parameters: - name: enabled in: query required: false schema: type: boolean description: Filter by enabled status responses: '200': description: Queues retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetAnnotationQueuesResponse' post: tags: - Queues operationId: createQueueLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: createQueue discriminator: project_id x-ts-sdk-exclude: true x-cli-exclude: true summary: Create an annotation queue (deprecated) description: Deprecated. Use `POST /v1/projects/{project_id}/queues` with a data plane API key instead. Creates a new annotation queue with a name, optional description, filters, and an initial set of event IDs to add. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationQueueRequest' responses: '201': description: Queue created successfully content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationQueueResponse' '400': description: Bad request (invalid queue data or missing required fields) /v1/projects/{project_id}/queues: get: tags: - Queues operationId: getQueues security: - DataPlaneApiKey: [] x-ts-sdk-exclude: true x-cli-exclude: true summary: List annotation queues description: | List the annotation queues in the project that `project_id` names, optionally filtered by enabled status. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project whose annotation queues are listed - name: enabled in: query required: false schema: type: boolean description: Filter by enabled status responses: '200': description: Queues retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetAnnotationQueuesResponse' post: tags: - Queues operationId: createQueue security: - DataPlaneApiKey: [] x-ts-sdk-exclude: true x-cli-exclude: true summary: Create an annotation queue description: | Create a new annotation queue with a name, optional description, filters, and an initial set of event IDs to add. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project the annotation queue is created in requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationQueueRequest' responses: '201': description: Queue created successfully content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationQueueResponse' '400': description: Bad request (invalid queue data or missing required fields) /v1/queues/{queue_id}: get: tags: - Queues operationId: getQueueLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: getQueue discriminator: project_id x-ts-sdk-exclude: true x-cli-exclude: true summary: Get an annotation queue (deprecated) description: Deprecated. Use `GET /v1/projects/{project_id}/queues/{queue_id}` with a data plane API key instead. Retrieves a single annotation queue by its unique identifier. parameters: - name: queue_id in: path required: true schema: type: string description: Annotation queue ID responses: '200': description: Queue retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetAnnotationQueueByIdResponse' '404': description: Queue not found put: tags: - Queues operationId: updateQueueLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: updateQueue discriminator: project_id x-ts-sdk-exclude: true x-cli-exclude: true summary: Update an annotation queue (deprecated) description: Deprecated. Use `PATCH /v1/projects/{project_id}/queues/{queue_id}` with a data plane API key instead. Updates fields on an existing annotation queue. Supports updating name, description, filters, enabled status, and adding/removing events. parameters: - name: queue_id in: path required: true schema: type: string description: Annotation queue ID requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAnnotationQueueRequest' responses: '200': description: Queue updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateAnnotationQueueResponse' '404': description: Queue not found delete: tags: - Queues operationId: deleteQueueLegacy security: - BearerAuth: [] deprecated: true x-hidden: true x-twin: op: deleteQueue discriminator: project_id x-ts-sdk-exclude: true x-cli-exclude: true summary: Delete an annotation queue (deprecated) description: Deprecated. Use `DELETE /v1/projects/{project_id}/queues/{queue_id}` with a data plane API key instead. Soft-deletes an annotation queue by its unique identifier. parameters: - name: queue_id in: path required: true schema: type: string description: Annotation queue ID responses: '200': description: Queue deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteAnnotationQueueResponse' '404': description: Queue not found /v1/projects/{project_id}/queues/{queue_id}: get: tags: - Queues operationId: getQueue security: - DataPlaneApiKey: [] x-ts-sdk-exclude: true x-cli-exclude: true summary: Get an annotation queue description: Retrieve a single annotation queue by its unique identifier. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds the annotation queue - name: queue_id in: path required: true schema: type: string description: Annotation queue ID responses: '200': description: Queue retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetAnnotationQueueByIdResponse' '404': description: Queue not found patch: tags: - Queues operationId: updateQueue security: - DataPlaneApiKey: [] x-ts-sdk-exclude: true x-cli-exclude: true summary: Update an annotation queue description: | Update fields on an existing annotation queue. Supports updating name, description, filters, enabled status, and adding/removing events. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds the annotation queue - name: queue_id in: path required: true schema: type: string description: Annotation queue ID requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAnnotationQueueRequest' responses: '200': description: Queue updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateAnnotationQueueResponse' '404': description: Queue not found delete: tags: - Queues operationId: deleteQueue security: - DataPlaneApiKey: [] x-ts-sdk-exclude: true x-cli-exclude: true summary: Delete an annotation queue description: Soft-delete an annotation queue by its unique identifier. parameters: - in: path name: project_id required: true schema: type: string description: The unique identifier of the project that holds the annotation queue - name: queue_id in: path required: true schema: type: string description: Annotation queue ID responses: '200': description: Queue deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteAnnotationQueueResponse' '404': description: Queue not found /v1/configurations: get: summary: Retrieve a list of configurations operationId: getConfigurations security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true tags: - Configurations description: List configurations with optional filtering by name, environment, and tags. parameters: - name: name in: query required: false schema: type: string description: The name of the configuration like `v0` - name: env in: query required: false schema: type: string description: Environment - "dev", "staging" or "prod" - name: tags in: query required: false schema: type: string description: Tags to filter configurations responses: '200': description: Configurations retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetConfigurationsResponse' post: summary: Create a new configuration operationId: createConfiguration security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true tags: - Configurations description: Create a new LLM or pipeline configuration with provider, parameters, and environment settings. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationRequest' responses: '200': description: Configuration created successfully content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationResponse' /v1/configurations/{configId}: put: summary: Update an existing configuration operationId: updateConfiguration security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true tags: - Configurations description: Update an existing configuration's name, provider, parameters, environment, or tags. parameters: - name: configId in: path required: true schema: type: string description: Configuration ID like `6638187d505c6812e4043f24` requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationRequest' responses: '200': description: Configuration updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationResponse' delete: summary: Delete a configuration operationId: deleteConfiguration security: - BearerAuth: [] x-cli-exclude: true x-ts-sdk-exclude: true deprecated: true x-hidden: true tags: - Configurations description: Permanently delete a configuration by its unique identifier. parameters: - name: configId in: path required: true schema: type: string description: Configuration ID like `6638187d505c6812e4043f24` responses: '200': description: Configuration deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeleteConfigurationResponse' components: securitySchemes: BearerAuth: type: http scheme: bearer IngestionApiKey: type: http scheme: bearer description: An Ingestion API Key (values begin with `hh_ingst_`). Scoped to a single project and accepted only by the ingestion endpoints; every other Data Plane operation refuses it. Create one in the HoneyHive app under the project's **Settings → API Keys**, on the **Ingestion** tab. DataPlaneApiKey: type: http scheme: bearer description: A fine-grained data plane API key (values begin with `hh_fgdp_`). Rooted at an organization, workspace, or project, it carries the permissions chosen when it was created, and only the operations whose paths begin with `/v1/projects/{project_id}/` accept it. Create one in the HoneyHive app under the project's, workspace's, or organization's **Settings → API Keys**, on the **Data Plane** tab. schemas: SingleFilter: type: object properties: field: type: string operator: type: string enum: - exists - not exists - is - is not - contains - not contains - greater than - less than - after - before value: anyOf: - type: string - type: number - type: boolean - type: 'null' type: type: string enum: - string - number - boolean - datetime required: - field - operator - value - type Pagination: type: object properties: page: type: integer minimum: 1 limit: type: integer minimum: 1 total: type: integer minimum: 0 total_unfiltered: type: integer minimum: 0 total_pages: type: integer minimum: 0 has_next: type: boolean has_prev: type: boolean required: - page - limit - total - total_unfiltered - total_pages - has_next - has_prev CreateDataPlaneApiKeyRequest: type: object properties: name: type: string minLength: 1 maxLength: 256 description: A name for the key, shown in the key list. description: type: string maxLength: 1024 description: What the key is for. permissions: type: array items: type: string minItems: 1 description: The permissions the key carries, such as `project.chart.get`. Each must be one the key's root scope can carry and one the organization's data plane key policy allows; the key creation screen under the project's Settings → API Keys lists them. expires_at: type: string format: date-time description: When the key expires, as an ISO 8601 timestamp. It must be in the future and within the maximum key lifetime; a later value is refused with the limit named. required: - name - permissions - expires_at additionalProperties: false CreateDataPlaneApiKeyResponse: type: object properties: success: type: boolean enum: - true data: $ref: '#/components/schemas/CreateDataPlaneApiKeyResponseData' required: - success - data additionalProperties: false CreateIngestionApiKeyRequest: type: object properties: name: type: string minLength: 1 maxLength: 256 description: A name for the key, shown in the key list. description: type: string maxLength: 1024 description: What the key is for. required: - name additionalProperties: false CreateIngestionApiKeyResponse: type: object properties: success: type: boolean enum: - true data: $ref: '#/components/schemas/CreateIngestionApiKeyResponseData' required: - success - data additionalProperties: false ChartQueryRequest: type: object properties: date_range: $ref: '#/components/schemas/ChartQueryDateRange' filters: type: array items: $ref: '#/components/schemas/EventSearchFilter' maxItems: 20 description: Implicit AND; default none product_filters: $ref: '#/components/schemas/ChartQueryProductFilters' query: $ref: '#/components/schemas/ChartQuery' required: - date_range - query additionalProperties: false description: Request body for POST /v1/charts/query ChartQueryDateRange: type: object properties: start_time: type: string format: date-time description: RFC 3339 start of the range (inclusive); Z or explicit offset end_time: type: string format: date-time description: RFC 3339 end of the range (exclusive); Z or explicit offset timezone: type: string minLength: 1 description: IANA timezone name; defaults to UTC. Affects bucket alignment only. required: - start_time - end_time additionalProperties: false EventSearchFilter: type: object properties: field: type: string operator: type: string enum: - exists - not exists - is - is not - contains - not contains - greater than - less than - after - before value: anyOf: - type: string - type: number - type: boolean - type: 'null' type: type: string enum: - string - number - boolean - datetime required: - field - operator - value additionalProperties: false ChartQueryProductFilters: type: object properties: experiment_run_id: type: string minLength: 1 description: Restrict to one experiment run only_experiments: type: boolean description: Restrict to events belonging to any experiment run additionalProperties: false ChartQuery: oneOf: - $ref: '#/components/schemas/ChartQueryTimeSeries' - $ref: '#/components/schemas/ChartQueryCategorical' - $ref: '#/components/schemas/ChartQueryScalar' - $ref: '#/components/schemas/ChartQueryHistogram' - $ref: '#/components/schemas/ChartQueryTable' - $ref: '#/components/schemas/ChartQueryScatter' discriminator: propertyName: kind mapping: time_series: '#/components/schemas/ChartQueryTimeSeries' categorical: '#/components/schemas/ChartQueryCategorical' scalar: '#/components/schemas/ChartQueryScalar' histogram: '#/components/schemas/ChartQueryHistogram' table: '#/components/schemas/ChartQueryTable' scatter: '#/components/schemas/ChartQueryScatter' ChartQueryTimeSeries: type: object properties: kind: type: string enum: - time_series bucket: $ref: '#/components/schemas/ChartQueryBucket' split_by: type: string minLength: 1 description: Groupable field; one series per value measures: type: array items: $ref: '#/components/schemas/ChartQueryMeasure' minItems: 1 maxItems: 5 description: Display-ordered measures, same unit; exactly one when split_by is set split_ranking: $ref: '#/components/schemas/ChartQueryRanking' required: - kind - measures additionalProperties: false ChartQueryBucket: type: object properties: interval: type: string enum: - auto - 1m - 5m - 1h - 1d - 1w - 1M description: Bucket width; default auto max_points: type: integer minimum: 1 description: Ceiling on bucket count when interval is auto; widens the resolved interval, never narrows it. Default 200, max 1000 additionalProperties: false ChartQueryMeasure: type: object properties: id: type: string minLength: 1 description: Response handle for this measure; defaults to the metric name metric: type: string minLength: 1 description: Field name or intrinsic metric id aggregation: $ref: '#/components/schemas/ChartQueryAggregation' required: - metric additionalProperties: false ChartQueryAggregation: type: string enum: - count - avg - sum - min - max - median - p50 - p75 - p90 - p95 - p99 - percentage_true - percentage_false - percentage_null description: Omit for a registry default; must be omitted for intrinsic metrics ChartQueryRanking: type: object properties: limit: type: integer minimum: 1 description: Cap on ranked items; default 10, at most 50 direction: type: string enum: - asc - desc description: Rank order; default desc include_other: type: boolean description: Roll everything below the cap into an "Other" item; additive measures only additionalProperties: false description: Caps the split_by dimension ChartQueryCategorical: type: object properties: kind: type: string enum: - categorical group_by: type: string minLength: 1 description: Groupable field forming the axis split_by: type: string minLength: 1 description: Groupable field forming stacks/groups measures: type: array items: $ref: '#/components/schemas/ChartQueryMeasure' minItems: 1 maxItems: 5 description: Display-ordered measures, same unit; exactly one when split_by is set ranking: $ref: '#/components/schemas/ChartQueryRanking' description: Caps the group_by dimension split_ranking: $ref: '#/components/schemas/ChartQueryRanking' description: Caps the split_by dimension; default limit 10 even when omitted required: - kind - group_by - measures additionalProperties: false ChartQueryScalar: type: object properties: kind: type: string enum: - scalar measure: $ref: '#/components/schemas/ChartQueryMeasure' comparison: $ref: '#/components/schemas/ChartQueryScalarComparison' sparkline: $ref: '#/components/schemas/ChartQueryScalarSparkline' required: - kind - measure additionalProperties: false ChartQueryHistogram: type: object properties: kind: type: string enum: - histogram metric: type: string minLength: 1 description: Numeric field name; no aggregation bins: $ref: '#/components/schemas/ChartQueryHistogramBins' markers: type: array items: type: string enum: - p50 - p75 - p90 - p95 - p99 maxItems: 5 description: Percentile lines to compute on the same scan; default none required: - kind - metric additionalProperties: false ChartQueryTable: type: object properties: kind: type: string enum: - table group_by: type: array items: type: string minLength: 1 minItems: 1 maxItems: 3 description: Groupable fields forming row identity measures: type: array items: $ref: '#/components/schemas/ChartQueryMeasure' minItems: 1 maxItems: 5 description: Columns, in display order; units may differ order_by: $ref: '#/components/schemas/ChartQueryTableOrderBy' limit: type: integer minimum: 1 description: Default 50, at most 100 required: - kind - group_by - measures additionalProperties: false ChartQueryScatter: type: object properties: kind: type: string enum: - scatter group_by: type: string minLength: 1 description: One groupable field forming point identity x: $ref: '#/components/schemas/ChartQueryMeasure' y: $ref: '#/components/schemas/ChartQueryMeasure' limit: type: integer minimum: 1 description: Default 100, clamped to 500 required: - kind - group_by - x - y additionalProperties: false ChartQueryResponse: type: object properties: success: type: boolean data: $ref: '#/components/schemas/ChartResult' required: - success - data additionalProperties: false description: Response body for POST /v1/charts/query ChartResult: oneOf: - $ref: '#/components/schemas/ChartResultTimeSeries' - $ref: '#/components/schemas/ChartResultCategorical' - $ref: '#/components/schemas/ChartResultScalar' - $ref: '#/components/schemas/ChartResultHistogram' - $ref: '#/components/schemas/ChartResultTable' - $ref: '#/components/schemas/ChartResultScatter' discriminator: propertyName: kind mapping: time_series: '#/components/schemas/ChartResultTimeSeries' categorical: '#/components/schemas/ChartResultCategorical' scalar: '#/components/schemas/ChartResultScalar' histogram: '#/components/schemas/ChartResultHistogram' table: '#/components/schemas/ChartResultTable' scatter: '#/components/schemas/ChartResultScatter' ChartResultTimeSeries: type: object properties: kind: type: string enum: - time_series meta: $ref: '#/components/schemas/ChartResultTimeSeriesMeta' measures: type: array items: $ref: '#/components/schemas/ChartResultMeasure' data: $ref: '#/components/schemas/ChartResultTimeSeriesData' required: - kind - meta - measures - data additionalProperties: false ChartResultWarning: type: object properties: code: type: string minLength: 1 description: Stable machine key; well-known values in CHART_RESULT_WARNING_CODES message: type: string description: Human-readable; UI affordances key off `code`, never this details: type: object additionalProperties: anyOf: - type: string - type: number description: 'Context the server already had, e.g. { field: "metadata.cost" } or a count' required: - code - message additionalProperties: false ChartResultMeasure: type: object properties: id: type: string label: type: string unit: type: string enum: - ms - usd - tokens - events - sessions - '%' - number format: type: string enum: - number - duration_ms - currency_usd - percent required: - id - label - unit - format additionalProperties: false ChartResultSeries: type: object properties: key: type: string description: Stable within a response; safe as a React key label: type: string description: Display string; "(empty)" for a stored empty string dimensions: type: object additionalProperties: type: string description: 'Machine-readable identity, e.g. { "config.model": "gpt-4o" }' values: type: array items: anyOf: - type: number - type: 'null' description: Positional, aligned to the kind’s axis array required: - key - label - dimensions - values additionalProperties: false ChartResultCategorical: type: object properties: kind: type: string enum: - categorical meta: $ref: '#/components/schemas/ChartResultCategoricalMeta' unit: type: string enum: - ms - usd - tokens - events - sessions - '%' - number format: type: string enum: - number - duration_ms - currency_usd - percent data: $ref: '#/components/schemas/ChartResultCategoricalData' required: - kind - meta - unit - format - data additionalProperties: false ChartResultCategory: type: object properties: key: type: string description: Stable within a response; safe as a React key label: type: string description: Display string; "(empty)" for a stored empty string dimensions: type: object additionalProperties: type: string description: 'Machine-readable identity, e.g. { "config.model": "gpt-4o" }' is_other: type: boolean enum: - true description: Present only on the "Other" rollup required: - key - label - dimensions additionalProperties: false ChartResultScalar: type: object properties: kind: type: string enum: - scalar meta: $ref: '#/components/schemas/ChartResultScalarMeta' measures: type: array items: $ref: '#/components/schemas/ChartResultMeasure' data: $ref: '#/components/schemas/ChartResultScalarData' required: - kind - meta - measures - data additionalProperties: false ChartResultHistogram: type: object properties: kind: type: string enum: - histogram meta: $ref: '#/components/schemas/ChartResultHistogramMeta' unit: type: string enum: - ms - usd - tokens - events - sessions - '%' - number format: type: string enum: - number - duration_ms - currency_usd - percent data: $ref: '#/components/schemas/ChartResultHistogramData' required: - kind - meta - unit - format - data additionalProperties: false ChartResultTable: type: object properties: kind: type: string enum: - table meta: $ref: '#/components/schemas/ChartResultTableMeta' measures: type: array items: $ref: '#/components/schemas/ChartResultMeasure' data: $ref: '#/components/schemas/ChartResultTableData' required: - kind - meta - measures - data additionalProperties: false ChartResultScatter: type: object properties: kind: type: string enum: - scatter meta: $ref: '#/components/schemas/ChartResultScatterMeta' measures: type: array items: $ref: '#/components/schemas/ChartResultMeasure' data: $ref: '#/components/schemas/ChartResultScatterData' required: - kind - meta - measures - data additionalProperties: false CreateChartRequest: type: object properties: name: type: string maxLength: 200 description: Display name for the chart description: type: string description: Description of what the chart shows metric: type: string minLength: 1 description: Name of the metric to visualize func: type: string description: Aggregation function to apply (e.g. sum, avg, median, min, max) groupBy: type: - string - 'null' description: Field to group results by bucketing: type: string enum: - minute - five_minute - hour - day - week - month - auto default: day description: Time bucket granularity for aggregation dateRange: anyOf: - $ref: '#/components/schemas/RelativeDateRange' - $ref: '#/components/schemas/AbsoluteDateRange' description: Time range to query query: type: array items: $ref: '#/components/schemas/QueryFilter' description: Filters to apply to the chart data owner_id: type: string minLength: 1 description: ID of the user who owns this chart required: - name - metric additionalProperties: false RelativeDateRange: type: object properties: relative: type: string required: - relative additionalProperties: false AbsoluteDateRange: type: object properties: $gte: anyOf: - type: string - type: number $lte: anyOf: - type: string - type: number required: - $gte - $lte QueryFilter: type: object properties: field: type: string description: Name of the field to filter on value: type: - string - 'null' description: Value to compare against type: type: string description: Data type of the field (e.g. string, number) operator: type: string description: Comparison operator (e.g. is, is not, contains, greater than, less than) required: - field - value - type - operator additionalProperties: false CreateChartResponse: type: object properties: success: type: boolean data: $ref: '#/components/schemas/CreateChartResponseData' required: - success - data additionalProperties: false DeleteChartResponse: type: object properties: success: type: boolean message: type: string required: - success - message additionalProperties: false GetChartResponse: type: object properties: success: type: boolean data: $ref: '#/components/schemas/GetChartResponseData' required: - success - data additionalProperties: false GetChartsResponse: type: object properties: success: type: boolean data: type: array items: $ref: '#/components/schemas/GetChartsResponseDataItem' required: - success - data additionalProperties: false UpdateChartRequest: type: object properties: name: type: string maxLength: 200 description: Display name for the chart description: type: string description: Description of what the chart shows metric: type: string description: Name of the metric to visualize func: type: string description: Aggregation function to apply (e.g. sum, avg, median, min, max) groupBy: type: - string - 'null' description: Field to group results by bucketing: type: string enum: - minute - five_minute - hour - day - week - month - auto description: Time bucket granularity for aggregation dateRange: anyOf: - $ref: '#/components/schemas/RelativeDateRange' - $ref: '#/components/schemas/AbsoluteDateRange' description: Time range to query query: type: array items: $ref: '#/components/schemas/QueryFilter' description: Filters to apply to the chart data owner_id: type: string minLength: 1 description: ID of the user who owns this chart additionalProperties: false UpdateChartResponse: type: object properties: success: type: boolean data: $ref: '#/components/schemas/UpdateChartResponseData' required: - success - data additionalProperties: false SelectedFunction: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 description: type: string parameters: type: object additionalProperties: {} required: - id - name ResponseFormat: type: object properties: type: type: string enum: - text - json_object required: - type TemplateItem: type: object properties: role: type: string content: type: string required: - role - content ConfigurationParameters: type: object properties: call_type: type: string enum: - chat - completion model: type: string minLength: 1 hyperparameters: type: object additionalProperties: {} responseFormat: $ref: '#/components/schemas/ResponseFormat' selectedFunctions: type: array items: $ref: '#/components/schemas/SelectedFunction' functionCallParams: type: string enum: - none - auto - force forceFunction: type: object additionalProperties: {} template: anyOf: - type: array items: $ref: '#/components/schemas/TemplateItem' - type: string required: - call_type - model ConfigurationItem: type: object properties: id: type: string minLength: 1 name: type: string type: type: string enum: - LLM - pipeline provider: type: string parameters: $ref: '#/components/schemas/ConfigurationParameters' env: type: array items: type: string enum: - dev - staging - prod tags: type: array items: type: string user_properties: type: - object - 'null' additionalProperties: {} created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time required: - id - name - type - provider - parameters - env - tags - created_at CreateConfigurationRequest: type: object properties: name: type: string maxLength: 200 type: type: string enum: - LLM - pipeline default: LLM provider: type: string minLength: 1 parameters: $ref: '#/components/schemas/ConfigurationParameters' env: type: array items: type: string enum: - dev - staging - prod tags: type: array items: type: string user_properties: type: - object - 'null' additionalProperties: {} required: - name - provider - parameters additionalProperties: false description: Request body for POST /configurations UpdateConfigurationRequest: type: object properties: name: type: string maxLength: 200 type: type: string enum: - LLM - pipeline default: LLM provider: type: string minLength: 1 parameters: $ref: '#/components/schemas/ConfigurationParameters' env: type: array items: type: string enum: - dev - staging - prod tags: type: array items: type: string user_properties: type: - object - 'null' additionalProperties: {} required: - name additionalProperties: false description: Request body for PUT /configurations GetConfigurationsQuery: type: object properties: name: type: string maxLength: 200 description: Filter configurations by name env: type: string description: Filter configurations by environment tags: type: string description: Filter configurations by tags description: Query parameters for GET /configurations CreateConfigurationResponse: type: object properties: acknowledged: type: boolean insertedId: type: string minLength: 1 required: - acknowledged - insertedId description: Response for POST /configurations UpdateConfigurationResponse: type: object properties: acknowledged: type: boolean modifiedCount: type: number upsertedId: type: - string - 'null' upsertedCount: type: number matchedCount: type: number required: - acknowledged - modifiedCount - upsertedId - upsertedCount - matchedCount description: Response for PUT /configurations DeleteConfigurationResponse: type: object properties: acknowledged: type: boolean deletedCount: type: number required: - acknowledged - deletedCount description: Response for DELETE /configurations GetConfigurationsResponse: type: object properties: configurations: type: array items: $ref: '#/components/schemas/ConfigurationItem' required: - configurations description: Response for GET /configurations DatapointMapping: type: object properties: inputs: type: array items: type: string default: [] history: type: array items: type: string default: [] ground_truth: type: array items: type: string default: [] BatchDateRange: type: object properties: $gte: type: string $lte: type: string CheckState: type: object additionalProperties: type: boolean Datapoint: type: object properties: id: type: string minLength: 1 inputs: type: object additionalProperties: {} history: type: array items: type: object additionalProperties: {} ground_truth: type: - object - 'null' additionalProperties: {} metadata: type: - object - 'null' additionalProperties: {} linked_event: anyOf: - type: string - type: 'null' created_at: type: string updated_at: type: string linked_datasets: type: array items: type: string required: - id - inputs - history - ground_truth - metadata - linked_event - created_at GetDatapointsQuery: type: object properties: datapoint_ids: type: array items: type: string minLength: 1 description: List of datapoint IDs to fetch dataset_name: type: string maxLength: 200 description: Dataset name to filter by additionalProperties: false description: Query parameters for GET /datapoints GetDatapointParams: type: object properties: datapoint_id: type: string minLength: 1 description: Unique identifier of the datapoint required: - datapoint_id description: Path parameters for GET /datapoints/{datapoint_id} CreateDatapointRequest: type: object properties: inputs: type: object additionalProperties: {} default: {} history: type: array items: type: object additionalProperties: {} default: [] ground_truth: type: object additionalProperties: {} metadata: type: object additionalProperties: {} linked_event: type: string linked_datasets: type: array items: type: string minLength: 1 default: [] description: Request body for POST /datapoints UpdateDatapointRequest: type: object properties: inputs: type: object additionalProperties: {} history: type: array items: type: object additionalProperties: {} ground_truth: type: object additionalProperties: {} metadata: type: object additionalProperties: {} linked_event: type: string description: 'Deprecated: Ignored on updates. Set linked_event when creating a datapoint.' deprecated: true linked_datasets: type: array items: type: string minLength: 1 description: Request body for PUT /datapoints/{datapoint_id} UpdateDatapointParams: type: object properties: datapoint_id: type: string minLength: 1 required: - datapoint_id description: Path parameters for PUT /datapoints/{datapoint_id} DeleteDatapointParams: type: object properties: datapoint_id: type: string minLength: 1 required: - datapoint_id description: Path parameters for DELETE /datapoints/{datapoint_id} BatchCreateDatapointsRequest: type: object properties: events: type: array items: type: string minLength: 1 deprecated: true mapping: $ref: '#/components/schemas/DatapointMapping' deprecated: true filters: anyOf: - type: object additionalProperties: {} - type: array items: type: object additionalProperties: {} dateRange: $ref: '#/components/schemas/BatchDateRange' checkState: $ref: '#/components/schemas/CheckState' selectAll: type: boolean dataset_id: type: string minLength: 1 description: Request body for POST /datapoints/batch GetDatapointsResponse: type: object properties: datapoints: type: array items: $ref: '#/components/schemas/Datapoint' required: - datapoints description: Response for GET /datapoints GetDatapointResponse: type: object properties: datapoint: type: array items: $ref: '#/components/schemas/Datapoint' required: - datapoint description: Response for GET /datapoints/{datapoint_id} CreateDatapointResponse: type: object properties: inserted: type: boolean result: $ref: '#/components/schemas/CreateDatapointResponseResult' required: - inserted - result description: Response for POST /datapoints UpdateDatapointResponse: type: object properties: updated: type: boolean result: $ref: '#/components/schemas/UpdateDatapointResponseResult' required: - updated - result description: Response for PUT /datapoints/{datapoint_id} DeleteDatapointResponse: type: object properties: deleted: type: boolean required: - deleted description: Response for DELETE /datapoints/{datapoint_id} BatchCreateDatapointsResponse: type: object properties: inserted: type: boolean insertedIds: type: array items: type: string minLength: 1 required: - inserted - insertedIds description: Response for POST /datapoints/batch Dataset: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 description: type: - string - 'null' datapoints: type: array items: type: string minLength: 1 created_at: type: string updated_at: type: string required: - id - name - datapoints CreateDatasetRequest: type: object properties: name: type: string maxLength: 200 default: Untitled Dataset description: Name of the dataset description: type: string description: Description of the dataset datapoints: type: array items: type: string minLength: 1 default: [] description: Initial datapoint IDs to include description: Request body for POST /datasets UpdateDatasetRequest: type: object properties: name: type: string maxLength: 200 description: New dataset name description: type: string description: New dataset description datapoints: type: array items: type: string minLength: 1 description: Updated list of datapoint IDs additionalProperties: false description: Request body for PUT /datasets/{dataset_id} LegacyUpdateDatasetRequest: type: object properties: dataset_id: type: string minLength: 1 description: Unique identifier of the dataset to update name: type: string maxLength: 200 description: New dataset name description: type: string description: New dataset description datapoints: type: array items: type: string minLength: 1 description: Updated list of datapoint IDs required: - dataset_id description: Request body for PUT /datasets (deprecated — use PUT /datasets/{dataset_id}) deprecated: true DeleteDatasetParams: type: object properties: dataset_id: type: string minLength: 1 description: Unique identifier of the dataset to delete required: - dataset_id additionalProperties: false description: Path parameters for DELETE /datasets/{dataset_id} LegacyDeleteDatasetQuery: type: object properties: dataset_id: type: string minLength: 1 description: Unique identifier of the dataset to delete required: - dataset_id description: Query parameters for the deprecated DELETE /datasets. Use DELETE /projects/{project_id}/datasets/{dataset_id} instead. deprecated: true AddDatapointsToDatasetRequest: type: object properties: data: type: array items: type: object additionalProperties: {} minItems: 1 description: Array of datapoint data objects to add mapping: $ref: '#/components/schemas/DatapointMapping' description: Field mapping for inputs, ground truth, and history required: - data - mapping description: Request body for POST /datasets/{dataset_id}/datapoints LegacyRemoveDatapointFromDatasetParams: type: object properties: dataset_id: type: string minLength: 1 description: Unique identifier of the dataset datapoint_id: type: string minLength: 1 description: Unique identifier of the datapoint to remove required: - dataset_id - datapoint_id description: Path parameters for DELETE /datasets/{dataset_id}/{datapoint_id} (deprecated — use DELETE /datasets/{dataset_id}/datapoints/{datapoint_id}) deprecated: true CreateDatasetResponse: type: object properties: inserted: type: boolean result: $ref: '#/components/schemas/InsertResult' required: - inserted - result description: Response for POST /datasets InsertResult: type: object properties: insertedId: type: string minLength: 1 required: - insertedId UpdateDatasetResponse: type: object properties: result: $ref: '#/components/schemas/Dataset' required: - result description: Response for PUT /datasets GetDatasetsResponse: type: object properties: datasets: type: array items: $ref: '#/components/schemas/Dataset' required: - datasets description: Response for GET /datasets DeleteDatasetResponse: type: object properties: result: $ref: '#/components/schemas/DeleteResult' required: - result description: Response for DELETE /datasets DeleteResult: type: object properties: id: type: string minLength: 1 required: - id AddDatapointsResponse: type: object properties: inserted: type: boolean datapoint_ids: type: array items: type: string minLength: 1 required: - inserted - datapoint_ids description: Response for POST /datasets/{dataset_id}/datapoints RemoveDatapointResponse: type: object properties: dereferenced: type: boolean message: type: string required: - dereferenced - message description: Response for DELETE /datasets/{dataset_id}/datapoints/{datapoint_id} FiltersArray: type: array items: $ref: '#/components/schemas/SingleFilter' EventSearchFiltersArray: type: array items: $ref: '#/components/schemas/EventSearchFilter' Event: type: object properties: event_id: type: string project_id: type: string tenant: type: string event_name: type: string event_type: type: string metrics: type: object additionalProperties: {} metadata: type: object additionalProperties: {} feedback: $ref: '#/components/schemas/EventFeedback' required: - event_id - project_id - tenant additionalProperties: {} description: Minimal event object used by evaluation and session endpoints; permissive (passthrough) LegacyEvent: type: object properties: project: type: string deprecated: true description: Project name (ignored by server — project is determined from API key scope) project_id: type: string description: Project ID source: type: string description: Source of the event (e.g., sdk-python) event_name: type: string description: Name of the event event_type: type: string enum: - model - tool - chain - session description: Type of event (model, tool, chain, or session) event_id: type: string description: Unique event identifier session_id: type: string description: Session this event belongs to parent_id: type: string description: Parent event ID in the trace hierarchy children_ids: type: array items: type: string description: Child event IDs in the trace hierarchy config: type: object additionalProperties: {} description: Configuration used for this event inputs: type: object additionalProperties: {} description: Input data for the event outputs: type: object additionalProperties: {} description: Output data from the event error: type: - string - 'null' description: Error message if the event failed start_time: type: number description: Event start time as Unix milliseconds end_time: type: number description: Event end time as Unix milliseconds duration: type: number description: Event duration in milliseconds metadata: type: object additionalProperties: {} description: Arbitrary metadata for the event feedback: type: object additionalProperties: {} description: Feedback data associated with the event metrics: type: object additionalProperties: {} description: Metric values computed for the event user_properties: type: object additionalProperties: {} description: User properties associated with the event additionalProperties: {} description: Full event object for legacy event creation endpoints ModelEvent: type: object properties: project: type: string deprecated: true description: Project name (ignored by server — project is determined from API key scope) project_id: type: string description: Project ID source: type: string description: Source of the event (e.g., sdk-python) event_name: type: string description: Name of the event event_type: type: string enum: - model - tool - chain - session description: Type of event (model, tool, chain, or session) event_id: type: string description: Unique event identifier session_id: type: string description: Session this event belongs to parent_id: type: string description: Parent event ID in the trace hierarchy children_ids: type: array items: type: string description: Child event IDs in the trace hierarchy config: type: object additionalProperties: {} description: Configuration used for this event inputs: type: object additionalProperties: {} description: Input data for the event outputs: type: object additionalProperties: {} description: Output data from the event error: type: - string - 'null' deprecated: true description: Legacy alias — remapped to inputs.error for model events start_time: type: number description: Event start time as Unix milliseconds end_time: type: number description: Event end time as Unix milliseconds duration: type: number deprecated: true description: Legacy alias — remapped to inputs.duration for model events metadata: type: object additionalProperties: {} description: Arbitrary metadata for the event feedback: type: object additionalProperties: {} description: Feedback data associated with the event metrics: type: object additionalProperties: {} description: Metric values computed for the event user_properties: type: object additionalProperties: {} description: User properties associated with the event model_name: type: string description: Model identifier (either this or event_name required) model_version: type: string description: Model version string model: type: string deprecated: true description: Legacy alias for model_name messages: type: array items: {} deprecated: true description: Legacy alias — remapped to inputs.messages response: deprecated: true description: Legacy alias — remapped to outputs.response provider: type: string deprecated: true description: Legacy alias — remapped to inputs.provider usage: type: object additionalProperties: {} deprecated: true description: Legacy alias — remapped to inputs.usage cost: deprecated: true description: Legacy alias — remapped to inputs.cost hyperparameters: type: object additionalProperties: {} deprecated: true description: Legacy alias — remapped to inputs.hyperparameters template: deprecated: true description: Legacy alias — remapped to inputs.template template_inputs: deprecated: true description: Legacy alias — remapped to inputs.template_inputs tools: deprecated: true description: Legacy alias — remapped to inputs.tools tool_choice: deprecated: true description: Legacy alias — remapped to inputs.tool_choice response_format: deprecated: true description: Legacy alias — remapped to inputs.response_format additionalProperties: {} description: Model event object with model-specific fields and legacy aliases SessionProperties: type: object properties: session_name: type: string start_time: type: number description: Session start time as Unix milliseconds user_properties: type: object additionalProperties: {} metadata: type: object additionalProperties: {} additionalProperties: {} description: Session properties for batch event creation UpdateEventRequest: type: object properties: metadata: type: object additionalProperties: {} description: Metadata fields to merge into the event feedback: type: object additionalProperties: {} description: Feedback fields to merge into the event metrics: type: object additionalProperties: {} description: Metric values to merge into the event outputs: type: - object - 'null' additionalProperties: {} description: Output object to replace on the event. Must be an object or null; null preserves the existing outputs. Non-object values (strings, arrays, scalars) are rejected. config: type: object additionalProperties: {} description: Configuration fields to merge into the event user_properties: type: object additionalProperties: {} description: User properties to merge into the event duration: type: number description: Event duration in milliseconds end_time: type: number description: Unix timestamp in milliseconds for event end children_ids: type: array items: type: string description: IDs of child events to set (must be non-empty; an empty array is ignored) description: Request body for PUT /v1/events/{event_id} LegacyUpdateEventRequest: type: object properties: event_id: type: string description: Event ID to update metadata: type: object additionalProperties: {} description: Metadata fields to merge into the event feedback: type: object additionalProperties: {} description: Feedback fields to merge into the event metrics: type: object additionalProperties: {} description: Metric values to merge into the event outputs: type: - object - 'null' additionalProperties: {} description: Output object to replace on the event. Must be an object or null; null preserves the existing outputs. Non-object values (strings, arrays, scalars) are rejected. config: type: object additionalProperties: {} description: Configuration fields to merge into the event user_properties: type: object additionalProperties: {} description: User properties to merge into the event duration: type: number description: Event duration in milliseconds end_time: type: number description: Unix timestamp in milliseconds for event end children_ids: type: array items: type: string description: IDs of child events to set (must be non-empty; an empty array is ignored) required: - event_id description: Request to update an existing event (deprecated — use PUT /v1/events/{event_id}) deprecated: true PostEventRequest: type: object properties: project_id: type: string description: Project ID source: type: string description: Source of the event (e.g., sdk-python) event_name: type: string description: Name of the event event_type: type: string enum: - model - tool - chain - session description: Type of event (model, tool, chain, or session) event_id: type: string description: Unique event identifier session_id: type: string description: Session this event belongs to parent_id: type: string description: Parent event ID in the trace hierarchy children_ids: type: array items: type: string description: Child event IDs in the trace hierarchy config: type: object additionalProperties: {} description: Configuration used for this event inputs: type: object additionalProperties: {} description: Input data for the event outputs: type: object additionalProperties: {} description: Output data from the event error: type: - string - 'null' description: Error message if the event failed start_time: type: number description: Event start time as Unix milliseconds end_time: type: number description: Event end time as Unix milliseconds duration: type: number description: Event duration in milliseconds metadata: type: object additionalProperties: {} description: Arbitrary metadata for the event feedback: type: object additionalProperties: {} description: Feedback data associated with the event metrics: type: object additionalProperties: {} description: Metric values computed for the event user_properties: type: object additionalProperties: {} description: User properties associated with the event required: - event_type - inputs additionalProperties: false description: Request body for POST /v1/events (bare event object) LegacyPostEventRequest: type: object properties: event: $ref: '#/components/schemas/LegacyPostEventRequestEvent' required: - event description: Request body for POST /events (deprecated — use POST /v1/events) deprecated: true SearchEventsRequest: type: object properties: filters: $ref: '#/components/schemas/EventSearchFiltersArray' description: Array of filter criteria to apply dateRange: $ref: '#/components/schemas/SearchEventsRequestDateRange' limit: type: integer minimum: 1 maximum: 1000 description: Limit number of results (default 1000, max 1000) page: type: integer minimum: 1 description: Page number of results (default 1) ignore_order: type: boolean description: 'Deprecated: accepted but ignored. Results are always ordered by start_time descending.' evaluation_id: type: string description: Filter by evaluation/experiment run ID additionalProperties: false description: Request body for POST /v1/events/search LegacyExportEventsRequest: type: object properties: filters: $ref: '#/components/schemas/FiltersArray' description: Array of filter criteria to apply dateRange: $ref: '#/components/schemas/LegacyExportEventsRequestDateRange' projections: type: array items: type: string description: Fields to include in the response limit: type: number description: Limit number of results (default 1000, max 7500) page: type: number description: Page number of results (default 1) ignore_order: type: boolean description: If true, skip result ordering for faster queries evaluation_id: type: string description: Filter by evaluation/experiment run ID description: Request body for POST /v1/events/export PostModelEventRequest: type: object properties: model_event: $ref: '#/components/schemas/ModelEvent' required: - model_event description: Request body for POST /events/model PostEventBatchRequest: type: object properties: events: type: array items: $ref: '#/components/schemas/PostEventRequest' description: Array of events to create single_session: type: boolean description: If true, all events share the same session session_properties: $ref: '#/components/schemas/SessionProperties' required: - events additionalProperties: false description: Request body for POST /v1/events/batch LegacyPostEventBatchRequest: type: object properties: events: type: array items: $ref: '#/components/schemas/LegacyEvent' description: Array of events to create single_session: type: boolean description: If true, all events share the same session is_single_session: type: boolean deprecated: true description: Legacy field name for single_session (backward compatibility) session: $ref: '#/components/schemas/SessionProperties' description: Alias for session_properties (backward compatibility) deprecated: true session_properties: $ref: '#/components/schemas/SessionProperties' required: - events description: Request body for POST /events/batch (deprecated — use POST /v1/events/batch) deprecated: true PostModelEventBatchRequest: type: object properties: model_events: type: array items: $ref: '#/components/schemas/ModelEvent' description: Array of model events to create single_session: type: boolean description: If true, all events share the same session is_single_session: type: boolean deprecated: true description: Legacy field name for single_session (backward compatibility) session: $ref: '#/components/schemas/SessionProperties' description: Alias for session_properties (backward compatibility) deprecated: true session_properties: $ref: '#/components/schemas/SessionProperties' required: - model_events description: Request body for POST /events/model/batch GetEventsQuery: type: object properties: dateRange: anyOf: - $ref: '#/components/schemas/RelativeDateRange' - $ref: '#/components/schemas/AbsoluteDateRange' description: Date range filter filters: $ref: '#/components/schemas/FiltersArray' description: Event filters to apply projections: type: array items: type: string description: Fields to include in the response ignore_order: type: boolean description: If true, skip result ordering for faster queries limit: type: number description: Maximum number of results to return page: type: number description: Page number for pagination evaluation_id: type: string description: Filter by evaluation/experiment run ID description: Query parameters for GET /events PostEventResponse: type: object properties: success: type: boolean event_id: type: string required: - success - event_id description: Response after creating an event GetEventsResponse: type: object properties: events: type: array items: {} totalEvents: type: number required: - events - totalEvents description: Response for GET /events GetEventResponse: type: object properties: event: $ref: '#/components/schemas/GetEventResponseEvent' required: - event description: Response for GET /events/:event_id — single event payload ExportEventsResponse: type: object properties: events: type: array items: $ref: '#/components/schemas/LegacyEvent' count: type: number required: - events - count description: Response for POST /v1/events/search and POST /v1/events/export PostEventBatchResponse: type: object properties: event_ids: type: array items: type: string session_id: type: string success: type: boolean required: - event_ids - success description: Response for POST /events/batch PassingRange: type: object properties: min: type: number max: type: number MetricDatapoints: type: object properties: passed: type: array items: type: string description: Datapoint/session IDs that passed this metric failed: type: array items: type: string description: Datapoint/session IDs that failed this metric required: - passed - failed MetricDetail: type: object properties: metric_name: type: string metric_type: type: string enum: - COMPOSITE - PYTHON - LLM - HUMAN - CLIENT_SIDE description: Type of metric evaluator event_name: type: string description: Name of the event this metric was computed on event_type: type: string description: Type of event (model, tool, chain, session) aggregate: type: number description: Aggregated metric value values: type: array items: type: number description: Individual metric values across datapoints passing_range: $ref: '#/components/schemas/PassingRange' datapoints: $ref: '#/components/schemas/MetricDatapoints' required: - metric_name DatapointResult: type: object properties: datapoint_id: type: - string - 'null' session_id: type: string passed: type: boolean metrics: type: array items: {} required: - session_id - passed EventDetail: type: object properties: event_name: type: string event_type: type: string required: - event_name - event_type ExperimentSchemaField: type: object properties: name: type: string event_type: type: string required: - name - event_type ExperimentSchemaMappingEntry: type: object properties: field_name: type: string event_type: type: string required: - field_name - event_type MetricsAggregation: type: object properties: aggregation_function: type: string details: type: array items: $ref: '#/components/schemas/MetricDetail' ExperimentRunObject: type: object properties: id: type: string run_id: type: string name: type: - string - 'null' description: type: - string - 'null' status: type: - string - 'null' metadata: type: object additionalProperties: {} results: type: object additionalProperties: {} metrics: type: object additionalProperties: type: number event_ids: type: array items: type: string configuration: type: object additionalProperties: {} is_active: type: boolean created_at: anyOf: - type: string - type: string format: date-time updated_at: anyOf: - type: string - type: string format: date-time - type: 'null' scope_type: type: string scope_id: type: string dataset_id: type: - string - 'null' dataset_name: type: - string - 'null' required: - id - run_id - metadata - results - event_ids - configuration - is_active - created_at - scope_type - scope_id EventComparisonDetail: type: object properties: event_name: type: string event_type: type: string presence: type: string enum: - old - new - both required: - event_name - event_type - presence MetricComparison: type: object properties: metric_name: type: string metric_type: type: string old_aggregate: type: number new_aggregate: type: number difference: type: number percentage_change: type: number required: - metric_name EventMetricData: type: object properties: event_name: type: string event_type: type: string session_id: type: string metadata: $ref: '#/components/schemas/EventMetricDataMetadata' metrics: type: object additionalProperties: anyOf: - type: number - type: boolean description: Metric name → value, merged from numeric, float, and boolean ClickHouse columns required: - event_name - event_type - session_id - metadata - metrics ComparableEvent: type: object properties: datapoint_id: type: string event_1: type: object additionalProperties: {} description: Full event record from the first run event_2: type: object additionalProperties: {} description: Full event record from the second run required: - datapoint_id - event_1 - event_2 PostExperimentRunRequest: type: object properties: run_id: type: string description: Optional client-generated UUID. A value that is not a valid UUID is replaced by a generated one; the response's run_id is authoritative. name: type: string minLength: 1 description: Experiment run display name description: type: string status: type: string enum: - pending - completed - failed - cancelled - running default: pending metadata: type: object additionalProperties: {} results: type: object additionalProperties: {} dataset_id: type: - string - 'null' event_ids: type: array items: type: string default: [] configuration: type: object additionalProperties: {} evaluators: type: array items: {} default: [] session_ids: type: array items: type: string default: [] datapoint_ids: type: array items: type: string minLength: 1 default: [] passing_ranges: type: object additionalProperties: $ref: '#/components/schemas/PassingRange' description: Request body for POST /runs PutExperimentRunRequest: type: object properties: name: type: string minLength: 1 description: Experiment run display name description: type: string status: type: string enum: - pending - completed - failed - cancelled - running metadata: type: object additionalProperties: {} results: type: object additionalProperties: {} event_ids: type: array items: type: string configuration: type: object additionalProperties: {} evaluators: type: array items: {} session_ids: type: array items: type: string datapoint_ids: type: array items: type: string minLength: 1 passing_ranges: type: object additionalProperties: $ref: '#/components/schemas/PassingRange' description: Request body for PUT /runs/{run_id} GetExperimentRunsQuery: type: object properties: dataset_id: type: string minLength: 1 description: Filter by dataset ID page: type: integer minimum: 1 default: 1 description: Page number for pagination limit: type: integer minimum: 1 maximum: 100 default: 20 description: Number of results per page (max 100) run_ids: type: array items: type: string description: Filter by specific run IDs name: type: string description: Filter by run name status: type: string enum: - pending - completed - failed - cancelled - running description: Filter by run status dateRange: anyOf: - type: string - $ref: '#/components/schemas/AbsoluteDateRange' description: Filter by date range sort_by: type: string enum: - created_at - updated_at - name - status default: created_at description: Field to sort results by sort_order: type: string enum: - asc - desc default: desc description: Sort order description: Query parameters for GET /runs GetExperimentRunParams: type: object properties: run_id: type: string required: - run_id description: Path parameters for GET /runs/{run_id} GetExperimentRunMetricsQuery: type: object properties: dateRange: type: string description: Date range filter as JSON string filters: anyOf: - type: string - type: array items: {} description: Filters to apply to metrics description: Query parameters for GET /runs/{run_id}/metrics LegacyGetExperimentRunResultQuery: type: object properties: aggregate_function: type: string default: average description: 'Aggregation function to apply (default: average)' filters: anyOf: - type: string - type: array items: {} description: Filters to apply to results description: Query parameters for GET /runs/{run_id}/result (deprecated — use GET /runs/{run_id}/summary) deprecated: true LegacyGetExperimentRunCompareParams: type: object properties: new_run_id: type: string description: The new run ID to compare old_run_id: type: string description: The old run ID to compare against required: - new_run_id - old_run_id description: Path parameters for GET /runs/{new_run_id}/compare-with/{old_run_id} (deprecated — use GET /runs/{new_run_id}/compare/{old_run_id}) deprecated: true LegacyGetExperimentRunCompareQuery: type: object properties: aggregate_function: type: string default: average description: 'Aggregation function to apply (default: average)' filters: anyOf: - type: string - type: array items: {} description: Filters to apply to comparison description: Query parameters for GET /runs/{new_run_id}/compare-with/{old_run_id} (deprecated — use GET /runs/{new_run_id}/compare/{old_run_id}) deprecated: true LegacyGetExperimentRunCompareEventsQuery: type: object properties: run_id_1: type: string description: First run ID to compare run_id_2: type: string description: Second run ID to compare event_name: type: string description: Filter by event name event_type: type: string description: Filter by event type filter: anyOf: - type: string - type: object additionalProperties: {} description: Additional filter criteria limit: type: integer exclusiveMinimum: 0 maximum: 1000 default: 1000 description: Maximum number of results (max 1000) page: type: integer exclusiveMinimum: 0 default: 1 description: Page number for pagination required: - run_id_1 - run_id_2 description: Query parameters for GET /runs/compare/events (deprecated — use GET /runs/{new_run_id}/compare/{old_run_id}/events) deprecated: true DeleteExperimentRunParams: type: object properties: run_id: type: string required: - run_id description: Path parameters for DELETE /runs/{run_id} LegacyGetEventsSchemaQuery: type: object properties: dateRange: anyOf: - type: string - $ref: '#/components/schemas/AbsoluteDateRange' description: Date range to filter schema by evaluation_id: type: string description: Filter by evaluation/run ID description: Query parameters for GET /events/schema (deprecated — use GET /runs/{run_id}/schema or GET /runs/schema) deprecated: true PostExperimentRunResponse: type: object properties: evaluation: $ref: '#/components/schemas/ExperimentRunObject' run_id: type: string required: - evaluation - run_id description: Response for POST /runs PutExperimentRunResponse: type: object properties: evaluation: $ref: '#/components/schemas/ExperimentRunObject' warning: type: string required: - evaluation description: Response for PUT /runs/{run_id} GetExperimentRunsResponse: type: object properties: evaluations: type: array items: $ref: '#/components/schemas/ExperimentRunObject' pagination: $ref: '#/components/schemas/Pagination' metrics: type: array items: type: string required: - evaluations - pagination - metrics description: Response for GET /runs GetExperimentRunResponse: type: object properties: evaluation: $ref: '#/components/schemas/ExperimentRunObject' required: - evaluation description: Response for GET /runs/{run_id} GetExperimentRunResultResponse: type: object properties: status: type: string success: type: boolean error: type: string passed: type: array items: type: string failed: type: array items: type: string metrics: $ref: '#/components/schemas/MetricsAggregation' datapoints: type: array items: $ref: '#/components/schemas/DatapointResult' event_details: type: array items: $ref: '#/components/schemas/EventDetail' run_object: $ref: '#/components/schemas/ExperimentRunObject' required: - status - success - passed - failed - metrics - datapoints - event_details - run_object description: 'Evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.' GetExperimentRunCompareResponse: type: object properties: metrics: type: array items: $ref: '#/components/schemas/MetricComparison' commonDatapoints: type: array items: type: string event_details: type: array items: $ref: '#/components/schemas/EventComparisonDetail' old_run: $ref: '#/components/schemas/ExperimentRunObject' new_run: $ref: '#/components/schemas/ExperimentRunObject' required: - metrics - commonDatapoints - event_details - old_run - new_run description: Comparison between two experiment runs including metrics, common datapoints, and event details GetExperimentRunMetricsResponse: type: object properties: events: type: array items: $ref: '#/components/schemas/EventMetricData' totalEvents: type: integer description: Total number of events matching the query required: - events - totalEvents description: Response for GET /runs/{run_id}/metrics GetEventsSchemaResponse: type: object properties: fields: type: array items: $ref: '#/components/schemas/ExperimentSchemaField' datasets: type: array items: type: string mappings: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ExperimentSchemaMappingEntry' required: - fields - datasets - mappings description: Response for GET /events/schema, GET /runs/{run_id}/schema, and GET /runs/schema GetExperimentCompareEventsResponse: type: object properties: events: type: array items: $ref: '#/components/schemas/ComparableEvent' totalEvents: type: integer description: Total number of events matching the comparison query required: - events - totalEvents description: Response for GET /runs/{new_run_id}/compare/{old_run_id}/events DeleteExperimentRunResponse: type: object properties: id: type: string deleted: type: boolean required: - id - deleted description: Response for DELETE /runs/{run_id} MetricItem: type: object properties: name: type: string maxLength: 200 type: type: string enum: - PYTHON - LLM - HUMAN - COMPOSITE criteria: type: string minLength: 1 description: type: - string - 'null' return_type: type: string enum: - float - boolean - string - categorical enabled_in_prod: type: boolean sampling_percentage: type: number minimum: 0 maximum: 100 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/MetricItemCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/MetricItemChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/MetricItemFilters' id: type: string minLength: 1 created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time required: - name - type - criteria - description - return_type - enabled_in_prod - sampling_percentage - needs_ground_truth - filters - id - created_at - updated_at additionalProperties: false CreateMetricRequest: type: object properties: name: type: string maxLength: 200 type: type: string enum: - PYTHON - LLM - HUMAN - COMPOSITE criteria: type: string minLength: 1 description: type: string default: '' return_type: type: string enum: - float - boolean - string - categorical default: float enabled_in_prod: type: boolean default: false sampling_percentage: type: number minimum: 0 maximum: 100 default: 10 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/CreateMetricRequestCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/CreateMetricRequestChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/CreateMetricRequestFilters' required: - name - type - criteria additionalProperties: false description: Request body for POST /metrics UpdateMetricRequest: type: object properties: name: type: string maxLength: 200 type: type: string enum: - PYTHON - LLM - HUMAN - COMPOSITE criteria: type: string minLength: 1 description: type: - string - 'null' return_type: type: string enum: - float - boolean - string - categorical enabled_in_prod: type: boolean sampling_percentage: type: number minimum: 0 maximum: 100 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: $ref: '#/components/schemas/UpdateMetricRequestThreshold' categories: type: array items: $ref: '#/components/schemas/UpdateMetricRequestCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/UpdateMetricRequestChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/UpdateMetricRequestFilters' additionalProperties: false description: Request body for PUT /metrics/{metric_id} LegacyUpdateMetricRequest: type: object properties: name: type: string maxLength: 200 type: type: string enum: - PYTHON - LLM - HUMAN - COMPOSITE criteria: type: string minLength: 1 description: type: - string - 'null' return_type: type: string enum: - float - boolean - string - categorical enabled_in_prod: type: boolean sampling_percentage: type: number minimum: 0 maximum: 100 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/LegacyUpdateMetricRequestCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/LegacyUpdateMetricRequestChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/LegacyUpdateMetricRequestFilters' id: type: string minLength: 1 required: - id additionalProperties: false description: Request body for PUT /metrics (deprecated — use PUT /metrics/{metric_id}) deprecated: true GetMetricsQuery: type: object properties: type: type: string description: Filter metrics by type id: type: string minLength: 1 description: Filter by metric ID description: Query parameters for GET /metrics RunMetricRequest: type: object properties: metric: $ref: '#/components/schemas/RunMetricRequestMetric' event: $ref: '#/components/schemas/RunMetricRequestEvent' required: - metric - event additionalProperties: false description: Request body for POST /metrics/run LegacyRunMetricRequest: type: object properties: metric: $ref: '#/components/schemas/LegacyRunMetricRequestMetric' event: $ref: '#/components/schemas/LegacyRunMetricRequestEvent' required: - metric - event description: Request body for POST /metrics/run_metric (deprecated — use POST /metrics/run) deprecated: true GetMetricsResponse: type: object properties: metrics: type: array items: $ref: '#/components/schemas/MetricItem' required: - metrics description: Response for GET /metrics CreateMetricResponse: type: object properties: inserted: type: boolean metric_id: type: string minLength: 1 required: - inserted - metric_id description: Response for POST /metrics UpdateMetricResponse: type: object properties: updated: type: boolean required: - updated description: Response for PUT /metrics DeleteMetricResponse: type: object properties: deleted: type: boolean required: - deleted description: Response for DELETE /metrics/{metric_id} RunMetricResponse: type: object properties: success: type: boolean loading: type: boolean result: anyOf: - type: boolean - type: number - type: string - type: 'null' explanation: type: - string - 'null' required: - success - loading - result - explanation description: Response for POST /metrics/run MetricVersionContent: type: object properties: name: type: string maxLength: 200 type: type: string enum: - PYTHON - LLM - HUMAN - COMPOSITE criteria: type: string minLength: 1 description: type: - string - 'null' return_type: type: string enum: - float - boolean - string - categorical enabled_in_prod: type: boolean sampling_percentage: type: number minimum: 0 maximum: 100 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/MetricVersionContentCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/MetricVersionContentChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/MetricVersionContentFilters' required: - name - type - criteria - description - return_type - enabled_in_prod - sampling_percentage - needs_ground_truth - filters additionalProperties: false description: Versioned snapshot of a metric definition. MetricVersionContentRequest: type: object properties: name: type: string maxLength: 200 type: type: string enum: - PYTHON - LLM - HUMAN - COMPOSITE criteria: type: string minLength: 1 description: type: string default: '' description: Free-form description of the metric. Defaults to an empty string. return_type: type: string enum: - float - boolean - string - categorical default: float description: Return type of the metric. Defaults to `float`. enabled_in_prod: type: boolean default: false description: Whether this version should run against production traffic. Defaults to `false` for non-HUMAN metrics and `true` for HUMAN metrics. sampling_percentage: type: number minimum: 0 maximum: 100 default: 10 description: Percentage of events the metric should run against, 0–100. Defaults to `10`. model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/MetricVersionContentRequestCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/MetricVersionContentRequestChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/MetricVersionContentRequestFilters' required: - name - type - criteria additionalProperties: false description: |- Metric definition snapshot accepted by POST /v1/metrics/{metric_id}/versions. Five fields are optional and fall back to server-side defaults when omitted: - `description` → `""` - `return_type` → `"float"` - `enabled_in_prod` → `true` for HUMAN metrics, `false` otherwise - `sampling_percentage` → `10` - `filters` → `{ "filterArray": [] }` MetricVersion: type: object properties: name: type: string full_sha: type: string message: type: string date: type: string format: date-time deployed: type: boolean content: $ref: '#/components/schemas/MetricVersionContent' required: - name - full_sha - message - date - deployed - content additionalProperties: false description: A versioned snapshot of a metric definition. CreateMetricVersionRequest: type: object properties: message: type: string content: $ref: '#/components/schemas/MetricVersionContentRequest' deploy_immediately: type: boolean required: - message - content additionalProperties: false description: Request body for POST /v1/metrics/{metric_id}/versions GetMetricVersionsResponse: type: object properties: success: type: boolean enum: - true data: type: array items: $ref: '#/components/schemas/MetricVersion' required: - success - data additionalProperties: false description: Response for GET /v1/metrics/{metric_id}/versions CreateMetricVersionResponse: type: object properties: success: type: boolean enum: - true data: $ref: '#/components/schemas/MetricVersion' required: - success - data additionalProperties: false description: Response for POST /v1/metrics/{metric_id}/versions DeployMetricVersionResponse: type: object properties: success: type: boolean enum: - true data: $ref: '#/components/schemas/MetricVersion' required: - success - data additionalProperties: false description: Response for POST /v1/metrics/{metric_id}/versions/{version_name}/deploy CreateAnnotationQueueRequest: type: object properties: name: type: string maxLength: 200 description: type: string maxLength: 1000 default: '' filters: $ref: '#/components/schemas/CreateAnnotationQueueRequestFilters' enabled: type: boolean default: true event_ids: type: array items: type: string default: [] required: - name UpdateAnnotationQueueRequest: type: object properties: name: type: string maxLength: 200 description: type: string maxLength: 1000 filters: $ref: '#/components/schemas/UpdateAnnotationQueueRequestFilters' enabled: type: boolean id: type: string minLength: 1 description: 'Deprecated: the queue id comes from the path, which overrides any value sent here.' deprecated: true add_event_ids: type: array items: type: string remove_event_ids: type: array items: type: string CreateAnnotationQueueResponse: type: object properties: queue: $ref: '#/components/schemas/CreateAnnotationQueueResponseQueue' message: type: string required: - queue - message UpdateAnnotationQueueResponse: type: object properties: queue: $ref: '#/components/schemas/UpdateAnnotationQueueResponseQueue' message: type: string required: - queue - message GetAnnotationQueuesResponse: type: object properties: queues: type: array items: $ref: '#/components/schemas/GetAnnotationQueuesResponseQueuesItem' required: - queues GetAnnotationQueueByIdResponse: type: object properties: name: type: string maxLength: 200 description: type: string maxLength: 1000 filters: $ref: '#/components/schemas/GetAnnotationQueueByIdResponseFilters' enabled: type: boolean id: type: string minLength: 1 scope_id: type: string scope_type: type: string enum: - system - controlplane - dataplane - org - workspace - project is_active: type: boolean created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time required: - name - description - filters - enabled - id - scope_id - scope_type - is_active - created_at - updated_at DeleteAnnotationQueueResponse: type: object properties: message: type: string required: - message PostSessionRequest: type: object properties: event_id: type: string project_id: type: string tenant: type: string event_name: type: string event_type: type: string metrics: type: object additionalProperties: {} metadata: type: object additionalProperties: {} feedback: $ref: '#/components/schemas/PostSessionRequestFeedback' required: - event_id - project_id - tenant additionalProperties: {} description: Minimal event object used by evaluation and session endpoints; permissive (passthrough) LegacyStartSessionRequest: type: object properties: session: $ref: '#/components/schemas/LegacyStartSessionRequestSession' required: - session description: Request body for POST /session/start (deprecated — use POST /v1/sessions) deprecated: true StartSessionRequest: type: object properties: session_id: type: string description: Client-provided session ID (server generates one if omitted) session_name: type: string description: Display name for the session event_name: type: string description: Fallback name if session_name is not provided source: type: string description: Source of the session (e.g., sdk-python) start_time: type: number description: Session start time as Unix milliseconds end_time: type: number description: Session end time as Unix milliseconds duration: type: number description: Session duration in milliseconds config: type: object additionalProperties: {} description: Configuration associated with the session inputs: type: object additionalProperties: {} description: Input data for the session outputs: type: object additionalProperties: {} description: Output data from the session metadata: type: object additionalProperties: {} description: Arbitrary metadata for the session user_properties: type: object additionalProperties: {} description: User properties associated with the session children_ids: type: array items: type: string description: IDs of child events in this session additionalProperties: false description: Request body for POST /v1/sessions (bare session object) AddSessionTracesRequest: type: object properties: logs: type: array items: $ref: '#/components/schemas/LegacyEvent' description: 'Deprecated: use `events` instead. Traces to add as raw event objects.' deprecated: true events: type: array items: $ref: '#/components/schemas/LegacyEvent' description: Traces to add as raw event objects. Replaces `logs`. description: Request body for POST /session/{session_id}/traces (deprecated — use POST /v1/sessions/{session_id}/events/batch). Exactly one of `logs` (deprecated) or `events` must be present. deprecated: true SessionEventBatchRequest: type: object properties: events: type: array items: $ref: '#/components/schemas/PostEventRequest' description: Events to add to the session required: - events additionalProperties: false description: Request body for POST /v1/sessions/{session_id}/events/batch PostSessionStartResponse: type: object properties: event_id: type: string session_id: type: string parent_id: type: - string - 'null' children_ids: type: array items: type: string event_type: type: - string - 'null' event_name: type: - string - 'null' config: {} inputs: {} outputs: {} error: type: - string - 'null' source: type: - string - 'null' duration: type: - number - 'null' user_properties: {} metrics: {} feedback: {} metadata: {} org_id: type: string workspace_id: type: string project_id: type: string start_time: type: - number - 'null' end_time: type: - number - 'null' required: - event_id - session_id - org_id - workspace_id - project_id additionalProperties: {} description: Full session event object returned after starting a new session SessionTracesResponse: type: object properties: success: type: boolean required: - success description: Response from adding traces to a session TODOSchema: type: object properties: message: type: string description: Placeholder - Zod schema not yet implemented required: - message description: Placeholder schema. The response shape for this endpoint is not yet fully specified; refer to the endpoint documentation for the fields it returns. CreateDataPlaneApiKeyResponseData: type: object properties: key_value: type: string key_id: type: string permissions: type: array items: type: string root_scope_type: type: string enum: - project root_scope_id: type: string expires_at: type: string format: date-time required: - key_value - key_id - permissions - root_scope_type - root_scope_id - expires_at additionalProperties: false CreateIngestionApiKeyResponseData: type: object properties: key_value: type: string key_id: type: string name: type: string description: type: - string - 'null' root_scope_type: type: string enum: - project root_scope_id: type: string required: - key_value - key_id - name - description - root_scope_type - root_scope_id additionalProperties: false ChartQueryScalarComparison: type: object properties: mode: type: string enum: - previous_period - none required: - mode additionalProperties: false description: Delta baseline; default none ChartQueryScalarSparkline: type: object properties: interval: type: string enum: - auto max_points: type: integer minimum: 1 description: Default 50; sparklines are small additionalProperties: false description: Omit for no sparkline — it is a second query, so it is opt-in ChartQueryHistogramBins: type: object properties: mode: type: string enum: - count count: type: integer minimum: 1 description: Default 20, at most 200 min: type: number description: Lower edge; discovered from the data when omitted max: type: number description: Upper edge; the p99 of the data when omitted, so one outlier cannot flatten the chart required: - mode additionalProperties: false ChartQueryTableOrderBy: type: object properties: field: type: string minLength: 1 description: A measure id or a group field; a measure wins if a name is both direction: type: string enum: - asc - desc required: - field additionalProperties: false description: 'Default: first measure, descending' ChartResultTimeSeriesMetaEffectiveBucket: type: object properties: interval: type: string fill: type: string enum: - zero - 'null' required: - interval - fill additionalProperties: false description: What the server resolved; the UI cannot label the x-axis without it ChartResultTimeSeriesMetaRanking: type: object properties: limit: type: number total_series: type: number required: - limit - total_series additionalProperties: false ChartResultTimeSeriesMeta: type: object properties: matched_event_count: type: number description: Rows in scope after filters and dedup; powers empty-state vs error-state UI warnings: type: array items: $ref: '#/components/schemas/ChartResultWarning' effective_bucket: $ref: '#/components/schemas/ChartResultTimeSeriesMetaEffectiveBucket' ranking: $ref: '#/components/schemas/ChartResultTimeSeriesMetaRanking' required: - matched_event_count - warnings - effective_bucket additionalProperties: false ChartResultTimeSeriesData: type: object properties: buckets: type: array items: type: string description: Full axis, no gaps; UTC instants of timezone-local bucket starts series: type: array items: $ref: '#/components/schemas/ChartResultSeries' required: - buckets - series additionalProperties: false ChartResultCategoricalMeta: type: object properties: warnings: type: array items: $ref: '#/components/schemas/ChartResultWarning' required: - warnings additionalProperties: false ChartResultCategoricalData: type: object properties: categories: type: array items: $ref: '#/components/schemas/ChartResultCategory' series: type: array items: $ref: '#/components/schemas/ChartResultSeries' required: - categories - series additionalProperties: false ChartResultScalarMeta: type: object properties: matched_event_count: type: number description: Rows in scope after filters and dedup; powers empty-state vs error-state UI warnings: type: array items: $ref: '#/components/schemas/ChartResultWarning' required: - matched_event_count - warnings additionalProperties: false ChartResultScalarDataComparisonSparkline: type: object properties: interval: type: string buckets: type: array items: type: string values: type: array items: anyOf: - type: number - type: 'null' required: - interval - buckets - values additionalProperties: false ChartResultScalarDataComparison: type: object properties: value: anyOf: - type: number - type: 'null' date_range: $ref: '#/components/schemas/ChartQueryDateRange' description: Server-derived; the UI labels the delta with this rather than re-deriving it sparkline: $ref: '#/components/schemas/ChartResultScalarDataComparisonSparkline' required: - value - date_range additionalProperties: false ChartResultScalarDataSparkline: type: object properties: interval: type: string buckets: type: array items: type: string values: type: array items: anyOf: - type: number - type: 'null' required: - interval - buckets - values additionalProperties: false ChartResultScalarData: type: object properties: value: anyOf: - type: number - type: 'null' comparison: $ref: '#/components/schemas/ChartResultScalarDataComparison' sparkline: $ref: '#/components/schemas/ChartResultScalarDataSparkline' required: - value additionalProperties: false ChartResultHistogramMeta: type: object properties: matched_event_count: type: number description: Rows in scope after filters and dedup; powers empty-state vs error-state UI warnings: type: array items: $ref: '#/components/schemas/ChartResultWarning' required: - matched_event_count - warnings additionalProperties: false ChartResultHistogramDataBinsItem: type: object properties: start: type: number end: anyOf: - type: number - type: 'null' count: type: number required: - start - end - count additionalProperties: false ChartResultHistogramData: type: object properties: bins: type: array items: $ref: '#/components/schemas/ChartResultHistogramDataBinsItem' markers: type: object additionalProperties: anyOf: - type: number - type: 'null' required: - bins - markers additionalProperties: false ChartResultTableMetaRanking: type: object properties: limit: type: number total_categories: type: number required: - limit - total_categories additionalProperties: false ChartResultTableMeta: type: object properties: matched_event_count: type: number description: Rows in scope after filters and dedup; powers empty-state vs error-state UI warnings: type: array items: $ref: '#/components/schemas/ChartResultWarning' ranking: $ref: '#/components/schemas/ChartResultTableMetaRanking' required: - matched_event_count - warnings - ranking additionalProperties: false ChartResultTableDataRowsItem: type: object properties: key: type: string description: Stable within a response; safe as a React key label: type: string description: Display string; "(empty)" for a stored empty string dimensions: type: object additionalProperties: type: string description: 'Machine-readable identity, e.g. { "config.model": "gpt-4o" }' values: type: object additionalProperties: anyOf: - type: number - type: 'null' required: - key - label - dimensions - values additionalProperties: false ChartResultTableData: type: object properties: rows: type: array items: $ref: '#/components/schemas/ChartResultTableDataRowsItem' required: - rows additionalProperties: false ChartResultScatterMeta: type: object properties: matched_event_count: type: number description: Rows in scope after filters and dedup; powers empty-state vs error-state UI warnings: type: array items: $ref: '#/components/schemas/ChartResultWarning' truncated: type: boolean description: True when the group count exceeded the limit required: - matched_event_count - warnings - truncated additionalProperties: false ChartResultScatterDataPointsItem: type: object properties: key: type: string description: Stable within a response; safe as a React key label: type: string description: Display string; "(empty)" for a stored empty string dimensions: type: object additionalProperties: type: string description: 'Machine-readable identity, e.g. { "config.model": "gpt-4o" }' x: type: number y: type: number weight: type: number required: - key - label - dimensions - x - y - weight additionalProperties: false ChartResultScatterData: type: object properties: points: type: array items: $ref: '#/components/schemas/ChartResultScatterDataPointsItem' required: - points additionalProperties: false CreateChartResponseData: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 description: type: - string - 'null' metric: type: string func: type: - string - 'null' groupBy: type: - string - 'null' bucketing: type: string dateRange: type: - object - 'null' additionalProperties: {} query: type: - array - 'null' items: $ref: '#/components/schemas/QueryFilter' owner_id: type: - string - 'null' minLength: 1 owner_profile: type: - object - 'null' additionalProperties: {} is_active: type: boolean created_at: anyOf: - type: string format: date-time - type: string updated_at: anyOf: - type: string format: date-time - type: string - type: 'null' required: - id - name - description - metric - func - groupBy - bucketing - dateRange - query - owner_id - is_active - created_at - updated_at GetChartResponseData: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 description: type: - string - 'null' metric: type: string func: type: - string - 'null' groupBy: type: - string - 'null' bucketing: type: string dateRange: type: - object - 'null' additionalProperties: {} query: type: - array - 'null' items: $ref: '#/components/schemas/QueryFilter' owner_id: type: - string - 'null' minLength: 1 owner_profile: type: - object - 'null' additionalProperties: {} is_active: type: boolean created_at: anyOf: - type: string format: date-time - type: string updated_at: anyOf: - type: string format: date-time - type: string - type: 'null' required: - id - name - description - metric - func - groupBy - bucketing - dateRange - query - owner_id - is_active - created_at - updated_at GetChartsResponseDataItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 description: type: - string - 'null' metric: type: string func: type: - string - 'null' groupBy: type: - string - 'null' bucketing: type: string dateRange: type: - object - 'null' additionalProperties: {} query: type: - array - 'null' items: $ref: '#/components/schemas/QueryFilter' owner_id: type: - string - 'null' minLength: 1 owner_profile: type: - object - 'null' additionalProperties: {} is_active: type: boolean created_at: anyOf: - type: string format: date-time - type: string updated_at: anyOf: - type: string format: date-time - type: string - type: 'null' required: - id - name - description - metric - func - groupBy - bucketing - dateRange - query - owner_id - is_active - created_at - updated_at UpdateChartResponseData: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 description: type: - string - 'null' metric: type: string func: type: - string - 'null' groupBy: type: - string - 'null' bucketing: type: string dateRange: type: - object - 'null' additionalProperties: {} query: type: - array - 'null' items: $ref: '#/components/schemas/QueryFilter' owner_id: type: - string - 'null' minLength: 1 owner_profile: type: - object - 'null' additionalProperties: {} is_active: type: boolean created_at: anyOf: - type: string format: date-time - type: string updated_at: anyOf: - type: string format: date-time - type: string - type: 'null' required: - id - name - description - metric - func - groupBy - bucketing - dateRange - query - owner_id - is_active - created_at - updated_at CreateDatapointResponseResult: type: object properties: insertedIds: type: array items: type: string minLength: 1 required: - insertedIds UpdateDatapointResponseResult: type: object properties: modifiedCount: type: number required: - modifiedCount EventFeedback: type: object properties: ground_truth: {} LegacyPostEventRequestEvent: type: object properties: project: type: string deprecated: true description: Project name (ignored by server — project is determined from API key scope) project_id: type: string description: Project ID source: type: string description: Source of the event (e.g., sdk-python) event_name: type: string description: Name of the event event_type: type: string enum: - model - tool - chain - session event_id: type: string description: Unique event identifier session_id: type: string description: Session this event belongs to parent_id: type: string description: Parent event ID in the trace hierarchy children_ids: type: array items: type: string description: Child event IDs in the trace hierarchy config: type: object additionalProperties: {} description: Configuration used for this event inputs: type: object additionalProperties: {} outputs: type: object additionalProperties: {} description: Output data from the event error: type: - string - 'null' description: Error message if the event failed start_time: type: number description: Event start time as Unix milliseconds end_time: type: number description: Event end time as Unix milliseconds duration: type: number description: Event duration in milliseconds metadata: type: object additionalProperties: {} description: Arbitrary metadata for the event feedback: type: object additionalProperties: {} description: Feedback data associated with the event metrics: type: object additionalProperties: {} description: Metric values computed for the event user_properties: type: object additionalProperties: {} description: User properties associated with the event required: - event_type - inputs additionalProperties: {} description: Full event object for legacy event creation endpoints SearchEventsRequestDateRange: type: object properties: start_time: type: string format: date-time description: ISO 8601 timestamp for start of date range (inclusive) end_time: type: string format: date-time description: ISO 8601 timestamp for end of date range (inclusive) required: - start_time - end_time additionalProperties: false LegacyExportEventsRequestDateRange: type: object properties: $gte: type: string description: ISO String for start of date range $lte: type: string description: ISO String for end of date range required: - $gte - $lte GetEventResponseEvent: type: object properties: project: type: string deprecated: true description: Project name (ignored by server — project is determined from API key scope) project_id: type: string description: Project ID source: type: string description: Source of the event (e.g., sdk-python) event_name: type: string description: Name of the event event_type: type: string enum: - model - tool - chain - session description: Type of event (model, tool, chain, or session) event_id: type: string session_id: type: string description: Session this event belongs to parent_id: type: string description: Parent event ID in the trace hierarchy children_ids: type: array items: type: string description: Child event IDs in the trace hierarchy config: type: object additionalProperties: {} description: Configuration used for this event inputs: type: object additionalProperties: {} description: Input data for the event outputs: type: object additionalProperties: {} description: Output data from the event error: type: - string - 'null' description: Error message if the event failed start_time: type: number description: Event start time as Unix milliseconds end_time: type: number description: Event end time as Unix milliseconds duration: type: number description: Event duration in milliseconds metadata: type: object additionalProperties: {} description: Arbitrary metadata for the event feedback: type: object additionalProperties: {} description: Feedback data associated with the event metrics: type: object additionalProperties: {} description: Metric values computed for the event user_properties: type: object additionalProperties: {} description: User properties associated with the event required: - event_id additionalProperties: {} description: Full event object for legacy event creation endpoints EventMetricDataMetadata: type: object properties: datapoint_id: type: string MetricItemCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false MetricItemChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false MetricItemFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false CreateMetricRequestCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false CreateMetricRequestChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false CreateMetricRequestFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' default: filterArray: [] required: - filterArray additionalProperties: false UpdateMetricRequestThreshold: type: object properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false UpdateMetricRequestCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false UpdateMetricRequestChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false UpdateMetricRequestFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false LegacyUpdateMetricRequestCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false LegacyUpdateMetricRequestChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false LegacyUpdateMetricRequestFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false RunMetricRequestMetricCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false RunMetricRequestMetricChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false RunMetricRequestMetricFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' default: filterArray: [] required: - filterArray additionalProperties: false RunMetricRequestMetric: type: object properties: name: type: string maxLength: 200 type: type: string enum: - LLM - PYTHON criteria: type: string minLength: 1 description: type: string default: '' return_type: type: string enum: - float - boolean - string - categorical default: float enabled_in_prod: type: boolean default: false sampling_percentage: type: number minimum: 0 maximum: 100 default: 10 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/RunMetricRequestMetricCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/RunMetricRequestMetricChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/RunMetricRequestMetricFilters' required: - name - type - criteria additionalProperties: false RunMetricRequestEventFeedback: type: object properties: ground_truth: {} additionalProperties: {} RunMetricRequestEvent: type: object properties: event_type: type: string event_name: type: string inputs: type: object additionalProperties: {} outputs: type: object additionalProperties: {} workspace_id: type: string description: 'Deprecated: ignored. The workspace whose provider credentials run the metric is derived from the caller’s authenticated scope.' deprecated: true feedback: $ref: '#/components/schemas/RunMetricRequestEventFeedback' additionalProperties: {} LegacyRunMetricRequestMetricCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false LegacyRunMetricRequestMetricChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false LegacyRunMetricRequestMetricFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' default: filterArray: [] required: - filterArray additionalProperties: false LegacyRunMetricRequestMetric: type: object properties: name: type: string maxLength: 200 type: type: string enum: - LLM - PYTHON criteria: type: string minLength: 1 description: type: string default: '' return_type: type: string enum: - float - boolean - string - categorical default: float enabled_in_prod: type: boolean default: false sampling_percentage: type: number minimum: 0 maximum: 100 default: 10 model_provider: type: - string - 'null' model_name: type: - string - 'null' scale: type: - integer - 'null' exclusiveMinimum: 0 threshold: type: - object - 'null' properties: min: type: number max: type: number pass_when: anyOf: - type: boolean - type: number passing_categories: type: array items: type: string maxLength: 200 minItems: 1 additionalProperties: false categories: type: - array - 'null' items: $ref: '#/components/schemas/LegacyRunMetricRequestMetricCategoriesItem' minItems: 1 needs_ground_truth: type: boolean description: Deprecated and ignored. Ground-truth use is inferred from the evaluator definition. deprecated: true child_metrics: type: - array - 'null' items: $ref: '#/components/schemas/LegacyRunMetricRequestMetricChildMetricsItem' minItems: 1 description: Deprecated and ignored. Composite metrics are no longer supported. deprecated: true filters: $ref: '#/components/schemas/LegacyRunMetricRequestMetricFilters' required: - name - type - criteria additionalProperties: false LegacyRunMetricRequestEventFeedback: type: object properties: ground_truth: {} additionalProperties: {} LegacyRunMetricRequestEvent: type: object properties: event_type: type: string event_name: type: string inputs: type: object additionalProperties: {} outputs: type: object additionalProperties: {} workspace_id: type: string description: 'Deprecated: ignored. The workspace whose provider credentials run the metric is derived from the caller’s authenticated scope.' deprecated: true feedback: $ref: '#/components/schemas/LegacyRunMetricRequestEventFeedback' additionalProperties: {} MetricVersionContentCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false MetricVersionContentChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false MetricVersionContentFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false MetricVersionContentRequestCategoriesItem: type: object properties: category: type: string maxLength: 200 score: type: - number - 'null' required: - category - score additionalProperties: false MetricVersionContentRequestChildMetricsItem: type: object properties: id: type: string minLength: 1 name: type: string maxLength: 200 weight: type: number scale: type: - integer - 'null' exclusiveMinimum: 0 required: - name - weight additionalProperties: false MetricVersionContentRequestFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' default: filterArray: [] required: - filterArray additionalProperties: false description: 'ETL filter narrowing which events this metric applies to. Defaults to `{ filterArray: [] }` (no filtering).' CreateAnnotationQueueRequestFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' default: filterArray: [] required: - filterArray additionalProperties: false UpdateAnnotationQueueRequestFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false CreateAnnotationQueueResponseQueueFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false CreateAnnotationQueueResponseQueue: type: object properties: name: type: string maxLength: 200 description: type: string maxLength: 1000 filters: $ref: '#/components/schemas/CreateAnnotationQueueResponseQueueFilters' enabled: type: boolean id: type: string minLength: 1 scope_id: type: string scope_type: type: string enum: - system - controlplane - dataplane - org - workspace - project is_active: type: boolean created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time required: - name - description - filters - enabled - id - scope_id - scope_type - is_active - created_at - updated_at UpdateAnnotationQueueResponseQueueFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false UpdateAnnotationQueueResponseQueue: type: object properties: name: type: string maxLength: 200 description: type: string maxLength: 1000 filters: $ref: '#/components/schemas/UpdateAnnotationQueueResponseQueueFilters' enabled: type: boolean id: type: string minLength: 1 scope_id: type: string scope_type: type: string enum: - system - controlplane - dataplane - org - workspace - project is_active: type: boolean created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time required: - name - description - filters - enabled - id - scope_id - scope_type - is_active - created_at - updated_at GetAnnotationQueuesResponseQueuesItemFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false GetAnnotationQueuesResponseQueuesItem: type: object properties: name: type: string maxLength: 200 description: type: string maxLength: 1000 filters: $ref: '#/components/schemas/GetAnnotationQueuesResponseQueuesItemFilters' enabled: type: boolean id: type: string minLength: 1 scope_id: type: string scope_type: type: string enum: - system - controlplane - dataplane - org - workspace - project is_active: type: boolean created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time required: - name - description - filters - enabled - id - scope_id - scope_type - is_active - created_at - updated_at GetAnnotationQueueByIdResponseFilters: type: object properties: filterArray: $ref: '#/components/schemas/FiltersArray' required: - filterArray additionalProperties: false PostSessionRequestFeedback: type: object properties: ground_truth: {} LegacyStartSessionRequestSession: type: object properties: session_id: type: string description: Client-provided session ID (server generates one if omitted) session_name: type: string description: Display name for the session event_name: type: string description: Fallback name if session_name is not provided source: type: string description: Source of the session (e.g., sdk-python) start_time: type: number description: Session start time as Unix milliseconds end_time: type: number description: Session end time as Unix milliseconds duration: type: number description: Session duration in milliseconds config: type: object additionalProperties: {} description: Configuration associated with the session inputs: type: object additionalProperties: {} description: Input data for the session outputs: type: object additionalProperties: {} description: Output data from the session metadata: type: object additionalProperties: {} description: Arbitrary metadata for the session user_properties: type: object additionalProperties: {} description: User properties associated with the session children_ids: type: array items: type: string description: IDs of child events in this session additionalProperties: {} GetEventsSchemaLegacyDateRangeOneOf1: type: object properties: $gte: oneOf: - type: string - type: number $lte: oneOf: - type: string - type: number GetRunsDateRangeOneOf1: type: object properties: $gte: oneOf: - type: string - type: number $lte: oneOf: - type: string - type: number GetRunsSchemaDateRangeOneOf1: type: object properties: $gte: oneOf: - type: string - type: number $lte: oneOf: - type: string - type: number GetRunSchemaDateRangeOneOf1: type: object properties: $gte: oneOf: - type: string - type: number $lte: oneOf: - type: string - type: number