Skip to main content
POST
Control an agent run

Authorizations

Authorization
string
header
required

OrgX API key, sent as Authorization: Bearer oxk_...

Headers

Idempotency-Key
string

Accepted for forward compatibility. Replay safety for this operation comes from its own state checks, described on the operation.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$

Path Parameters

runId
string<uuid>
required
action
enum<string>
required
Available options:
pause,
resume,
cancel,
rollback

Body

application/json
checkpointId
string

Required for rollback — the checkpoint to restore.

reason
string

Recorded alongside the control action.

Response

Action applied to the run

ok
boolean
required
data
object
required

The control result, including the run's new status.