List Runs

List runs for a thread.

GET /threads/{thread_id}/runs

List Runs

cURL

curl --request GET \
  --url https://api.example.com/threads/{thread_id}/runs

200

[
  {
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "kwargs": {}
  }
]

Path Parameters

thread_id · string<uuid> · required

The ID of the thread.

Query Parameters

limit · integer · default: 10

offset · integer · default: 0

status · enum<string>

Available options: pending, running, error, success, timeout, interrupted, skipped

select · enum<string>[]

Specify which fields to return. If not provided, all fields are returned.

Available options: run_id, thread_id, assistant_id, created_at, updated_at, status, metadata, kwargs, multitask_strategy

continuous_batch · boolean · default: false

When true, returns only the contiguous batch of runs matching the status filter starting at offset, stopping at the first run that doesn't match. Requires status to be set; cannot be combined with metadata.

Response

200

application/json

Success

run_id · string<uuid> · required

The ID of the run.

thread_id · string<uuid> · required

The ID of the thread.

assistant_id · string<uuid> · required

The assistant that was used for this run.

created_at · string<date-time> · required

The time the run was created.

updated_at · string<date-time> · required

The last time the run was updated.

status · enum<string> · required

The status of the run. One of 'pending', 'running', 'error', 'success', 'timeout', 'interrupted', 'skipped'. A 'skipped' run was pending but never executed (e.g. cancelled by interrupt multitask strategy before execution began).

Available options: pending, running, error, success, timeout, interrupted, skipped

metadata · Metadata · object · required

The run metadata.

kwargs · Kwargs · object · required

multitask_strategy · enum<string> · required

Strategy to handle concurrent runs on the same thread.

Available options: reject, rollback, interrupt, enqueue