Skip to content
AppHandoff AppHandoff Docs

Enqueue an operator control for a run lane (pause | resume | abort | nudge)

POST
/agents/runs/{id}/control
 
curl --request POST \
  --url https://example.com/api/agents/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/control \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "pause", "payload": { "message": "example", "reason": "example" } }'

Pull workers poll controls via the get_lane_controls MCP tool and ack via mark_lane_control_done; push lanes are actuated by the pump supervisor (abort cancels the provider run; pause/resume/nudge are acked unsupported_by_provider until providers support follow-ups).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
object
type
required
string
Allowed values: pause resume abort nudge
payload
object
message
string
<= 2000 characters
reason
string
<= 200 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Control enqueued

Media type application/json
object
control
required
object
id
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

400

Section titled “400 ”

Invalid request

Media type 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

401

Section titled “401 ”

Not authenticated

Media type 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

Section titled “403 ”

Forbidden

Media type 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

Section titled “404 ”

Not found

Media type 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

Section titled “429 ”

Rate limited

Media type 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

Section titled “Headers ”
Retry-After
string

500

Section titled “500 ”

Server error

Media type 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