Control history for a run lane (operator console)

GET

/agents/runs/{id}/control

const url = 'https://example.com/api/agents/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/control';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/control \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerApiKey
cookieAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Controls, oldest first

application/json

object

controls

required

Array<object>

object

required

string format: uuid

run_id

required

string format: uuid

project_id

required

string format: uuid

billing_account_id

required

string format: uuid

type

required

string

Allowed values: pause resume abort nudge

payload

required

object

key

additional properties

any

created_by_user_id

string | null format: uuid

created_at

required

string format: date-time

acked_at

required

string | null format: date-time

ack_result

required

string | null

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

404

Not found

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

429

Rate limited

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

retryAfter

Seconds until the rate limit resets

number

Headers

Retry-After

string

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