Start an agent run

Starts the run agentRun.start.preview showed: the same body with its confirmation_token, the same Idempotency-Key. Answers 201 with the run, or 200 with already_waiting and the run that waits. The run acts as the person and books what its policy lets it. A first run comes back awaiting_start: only a person's Start in Cybooks starts it, never an API call. 412 when the preview no longer holds (another scope, a run started since, another credit cap); 409 agent_run_waiting_other_scope when the run that waits was made for another scope; 409 agents_stopped while the company has stopped its agents. Requires the agent-runs:action OAuth scope with use_ask_cybooks_actions and the job's own permissions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Confirmed values used to start an agent run, including the confirmation token returned by agentRun.start.preview.

agentRun.start (agent runs AR16): the preview's body with the
confirmation token it gave.

string
required
length ≤ 64
^([a-z_]+|made:[0-9A-Za-z]{26})$

The agent to start: its key from agent.list (reconcile, receipt_chaser, or a made agent's made:<id>)

string
required
length ≤ 4096

The confirmation_token agentRun.start.preview returned for this body, sent with the same Idempotency-Key within 300 seconds

scope
object

What the run works on, when not all of its job: at least one limit the agent takes

Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*