Preview starting an agent run

Previews starting an agent (agent, a key from agent.list; optionally scope with bank_line_ids or payment_account_ids): status (running, or awaiting_start for its job's first run), waiting_run_id (a run that already waits for its Start), credit_cap and the confirmation_token agentRun.start needs with the same Idempotency-Key within 300 seconds. Writes nothing. 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

Proposed values used to preview starting an agent run without persisting changes.

What agentRun.start.preview and agentRun.start (agent runs AR16) take:
the agent, and optionally the run's limits under scope, as the app's
start takes them, without the app's files or conversation. The commit adds
its confirmation token ({@see StartAgentRunApiRequest}).

The limits (AR27, AD44, §4.20): every door key, each checked where every
door's are, by {@see AgentRunLimits::fromDoor()} when the start is
previewed and made, so a server key, a key the agent does not take, a bad
period, an id the caller may not read, a conflict or a line limit above
the job's cap is refused by name, as in the app and Ask. The rules here
only type the fields; they never answer for a limit. instruction (the
words, AR21) is refused, 422 {@see self::INSTRUCTION_APP_ONLY}, until the
owner decides D3a: words from another program steering a run are not
taken (spec §15).

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>)

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 operation-specific request key. This requirement does not imply durable public API response replay.

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
*/*