v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB

Agents

Create run

Creates a run in queued state. Call POST /agent/v1/run/:id/exec to start execution.

post/agent/v1/run

Request body

agentIdstring required

ID of the agent to run

promptstring required

Task prompt for the agent

guidancestring nullable

Additional guidance for this run

modelstring nullable

Override the agent default model for this run

objectIdsstring[] nullable

Scope this run to specific vault object IDs. The agent will only be able to access these objects during execution.

callbackUrlstring uri nullable

HTTPS callback URL to receive a notification when the run completes. Registered atomically with the run — eliminates the race condition of calling /watch after /exec. Additional watchers can still be added via POST /run/:id/watch.

Response

Run created in queued state

idstring

agentIdstring

status'queued'

objectIdsstring[] nullable

createdAtstring date-time