Start an agent run
POST
Starts a run of an agent your publication has already set up, and returns straight away. A run takes several minutes, so poll GET /v1/agents/{agentKey}/runs/{runId} for the drafts. Nothing publishes: a run produces drafts for someone to review in the app.
apiKeyheader
AuthorizationBearer <token>API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.
agentKey*stringWhich agent, such as changelog
Body
application/json- body
idempotencyKey*stringYour own key for this request. Sending it again returns the same run instead of starting a second one.
Length
1 <= length <= 200instructions?stringA note to steer this one run
Length
length <= 2000Run started
application/json- response
runId*stringIdentifier for the run you just started
status*stringWhere the run has got to
Value in
"queued""running""succeeded""completed_with_warnings""failed""blocked""canceled"curl -X POST "https://example.com/v1/agents/string/runs" \ -H "Content-Type: application/json" \ -d '{ "idempotencyKey": "string" }'{ "runId": "string", "status": "queued"}