Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key (ak_...) as a Bearer token. Preferred.

Body

application/json
name
string
required

Display name for the run, shown in the Clicks app.

Required string length: 1 - 200
template_id
string<uuid>
required

The ID of the agent that the API key belongs to. The key determines which agent runs; this field is only a cross-check, and a mismatch returns 403.

files
PublicAgentFileInput · object[]

Up to 10 files with a combined decoded size of 10 MiB. The API delivers them to the agent's workspace before it processes input_text, so the input can reference them by filename.

Maximum array length: 10
input_text
string | null

The agent's first input. Always send it: without it, the API creates the run but never starts a turn — the idle run reports finished until someone provides input in the Clicks app, and may be stopped automatically.

Response

Successful Response

Returned immediately; the run executes asynchronously.

agent_id
string<uuid>
required

The ID of the created run. Poll GET /v1/agents/{agent_id} for its status and transcript.