v2

OpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Experiments

Append runs to an experiment

Append new runs to an existing experiment.

Payload Requirements

  • Provide between 1 and 1000 runs in experiment_runs.
  • Each run must include:
    • output -- model/task output for the run
    • example_id -- the ID of an existing example in the dataset, required only when the experiment is associated with a dataset
    • You may include any additional fields per run that can be used for analysis or filtering. For example: model, latency_ms, temperature, prompt, tool_calls, etc.

Valid example

{
  "experiment_runs": [
    {"example_id": "example_001", "output": "4", "model": "gpt-4o-mini"}
  ]
}

Invalid example (missing required output field)

{
  "experiment_runs": [
    {"example_id": "example_001"}
  ]
}

<Note>This endpoint is in beta, read more here.</Note>

post/v2/experiments/{experiment_id}/runs

Path parameters

experiment_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique experiment identifier (base64)

Request body

Response

Experiment with the IDs of the newly inserted runs.

idstring required

Unique identifier for the experiment

namestring required

Name of the experiment

space_idstring required

Unique identifier for the space this experiment belongs to

dataset_idstring nullable

Unique identifier for the dataset associated with this experiment. Null if the experiment isn't associated with a dataset.

dataset_version_idstring nullable

Unique identifier for the dataset version associated with this experiment. Null if the experiment isn't associated with a dataset.

created_atstring date-time required

Timestamp for when the experiment was created

updated_atstring date-time required

Timestamp for the last update of the experiment

experiment_traces_project_idstring

Unique identifier for the experiment traces project this experiment belongs to (if it exists)

integration_idstring nullable

Identifier (base64) of the agent integration that backs this experiment, as returned by the integrations API. Null for non-agent experiments (for example, SDK or Playground experiments).

run_idsstring[] required

IDs of the newly inserted experiment runs, in input order.