Skip to content

List agent run lanes (monitor snapshot)

GET

/agents/runs

const url = 'https://example.com/api/agents/runs?attention=1&state=queued';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/agents/runs?attention=1&state=queued' \
  --header 'Authorization: Bearer <token>'

Snapshot of run lanes across the caller’s accessible projects, newest first (capped at 200). Live updates ride Supabase Realtime; this is the initial load. Optional project_id, plan_id, and state filters. Rate limited (120/min/IP).

Authorizations

bearerApiKey
cookieAuth

Parameters

Query Parameters

project_id

string format: uuid

plan_id

string format: uuid

attention

string

Allowed values: 1

‘1’ → only lanes flagged needs-attention (portal badges)

state

string

Allowed values: queued claimed running paused shipping shipped failed released

Filter by run state

Responses

200

Run lanes (newest first)

application/json

object

runs

required

Array<object>

object

id

required

string format: uuid

plan_id

required

string format: uuid

project_id

required

string format: uuid

billing_account_id

required

string format: uuid

milestone_id

required

string format: uuid

lane_key

required

string

title

required

string

role

required

string

Allowed values: frontend backend test design devops qa other

ticket_ids

required

Array<string>

state

required

string

Allowed values: queued claimed running paused shipping shipped failed released

phase

string | null

worker_id

Identity of the worker holding the claim (null until claimed).

string | null

claimed_at

string | null format: date-time

lease_expires_at

Claim lease deadline; reclaimed if a heartbeat does not renew it.

string | null format: date-time

last_heartbeat

string | null format: date-time

started_at

string | null format: date-time

finished_at

string | null format: date-time

worktree_path

string | null

branch

string | null

pr_url

string | null

last_log_line

string | null

external_ref

object | null

stall_flagged_at

string | null

self_report_state

string | null

shipping_started_at

string | null

attention_reason

string | null

Allowed values: stalled budget_paused shipping_timeout

attestation

object

tests_added

boolean

verify_passed

boolean | null

verify_command

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

403

Forbidden

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

500

Server error

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number