Skip to main content
POST
JavaScript

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string<uuid>
required

The ID of the agent to run.

Body

application/json

Request body for starting an agent run.

inputs
Inputs · object

Input values for the run. Keys should match the property names defined in schema.input. Omit the request body when the agent does not require inputs.

Response

Successful Response

Run details returned after a run request is accepted.

id
string<uuid>
required

Unique ID for the accepted run.

agent_id
string<uuid>
required

Unique ID of the agent for this run.

status
enum<string>
required

Initial status of the accepted run.

Available options:
queued,
running,
succeeded,
failed,
cancelled,
skipped,
unknown
started_at
string<date-time> | null

When the run started, if execution began immediately.