Skip to content

List Agent Runs

GET
/agent/runs

List runs this key can see: its own, plus org-wide shared ones.

Reconciles abandoned rows before reading, so a run whose worker was recycled reports failed rather than sitting at running forever.

Authorizations

Parameters

Query Parameters

statuses
Any of:
Array<string>

Optional repeatable status filter: ?statuses=running&statuses=queued

agent_id
Any of:
string
include_shared

When true (default), include org-wide shared runs. When false, return only runs this key owns.

boolean
default: true

When true (default), include org-wide shared runs. When false, return only runs this key owns.

limit
integer
default: 100 >= 1 <= 500
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
runs
required
Array<object>

One run. Identical shape whether read from the list or on its own.

object
agent_id
required
string
completed_at
Any of:
string
created_at
required
string
credit_budget
Any of:
integer
credits_spent
integer
current_step
Any of:
string
entry_point
Any of:
string
next_action
Any of:
string
session_id
Any of:
string
status
required
string
title
required
string
updated_at
required
string
visibility
required
string
work_item_id
required
string
total
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string