Skip to main content
POST
/
api
/
v1
/
datasets
/
{dataset_id}
/
runs
Error
A valid request URL is required to generate request examples
[
  {
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inputs": {},
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "runs": [
      {
        "name": "<string>",
        "trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "inputs": {},
        "inputs_preview": "<string>",
        "start_time": "2023-11-07T05:31:56Z",
        "end_time": "2023-11-07T05:31:56Z",
        "extra": {},
        "error": "<string>",
        "execution_order": 1,
        "serialized": {},
        "outputs": {},
        "outputs_preview": "<string>",
        "parent_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "manifest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "manifest_s3_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "events": [
          {}
        ],
        "tags": [
          "<string>"
        ],
        "inputs_s3_urls": {},
        "outputs_s3_urls": {},
        "s3_urls": {},
        "dotted_order": "<string>",
        "trace_min_start_time": "2023-11-07T05:31:56Z",
        "trace_max_start_time": "2023-11-07T05:31:56Z",
        "reference_example_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "total_tokens": 123,
        "prompt_tokens": 123,
        "completion_tokens": 123,
        "total_cost": "<string>",
        "prompt_cost": "<string>",
        "completion_cost": "<string>",
        "feedback_stats": {},
        "app_path": "<string>"
      }
    ],
    "outputs": {},
    "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "attachment_urls": {}
  }
]

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
dataset_id
string<uuid>
required

Query Parameters

​
format
string | null

Response format, e.g., 'csv'

Allowed value: "csv"

Body

application/json

Request DTO for querying examples with runs - used for API input.

This is separate from the internal schema to cleanly handle optional limit values. When limit is None, the internal schema will apply appropriate defaults based on format.

​
session_ids
string<uuid>[]
required
Minimum array length: 1
​
offset
integer
default:0
Required range: x >= 0
​
limit
integer | null
Required range: x >= 1
​
preview
boolean
default:false
​
comparative_experiment_id
string<uuid> | null
​
sort_params
SortParamsForRunsComparisonView · object
​
filters
Filters · object
​
example_ids
string<uuid>[] | null
Maximum array length: 1000
​
include_annotator_detail
boolean
default:false

Response

ExampleWithRunsCH · object[] | null

Successful Response

​
dataset_id
string<uuid>
required
​
inputs
Inputs · object
required
​
id
string<uuid>
required
​
name
string
required
​
runs
RunSchemaComparisonView · object[]
required
​
outputs
Outputs · object
​
source_run_id
string<uuid> | null
​
metadata
Metadata · object
​
created_at
string<date-time>
​
modified_at
string<date-time> | null
​
attachment_urls
Attachment Urls · object