DevelopersAPIReferenceagent_runs
Retrieve agent run
Retrieve one agent run: its status, the input it was started with, and its result once finished. Poll this after starting a run.
Authentication
Checking whether you're signed in…
GET
header
Authorization<token>A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.
companyId*stringLength
1 <= lengthid*stringLength
1 <= lengthAgent run
application/json- response
id*stringFormat
uuidcompanyId*stringFormat
uuiddefinitionId*stringThe agent definition (registry key) this run instantiates.
status*stringThe current lifecycle status of the run.
Value in
"open""running""needs_input""failed""succeeded"triggeredByUserId*|Format
uuidsuppressNotification*booleanimpersonatedBy*string|nullcreatedTime*stringFormat
date-timefinishedTime*|Format
date-timeerror*|Error message if the run failed.
errorDetails*|Detailed error information if the run failed.
sessionId*|The agent SDK session id — the handle to resume this run.
resumedFromRunId*|The terminal run this one continues, if any.
Format
uuidcloudRunExecutionId*string|nulllastHeartbeatTime*|Format
date-timecostUsd*|Accumulated model spend for the run, in USD.
data*|||||array<unknown>Kickoff input plus the throttled progress projection (summary, last tool, counters).
curl -X GET "https://example.com/companies/string/agent_runs/string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "definitionId": "string", "status": "open", "triggeredByUserId": "d1704798-c073-4631-a9e3-ed8329695e39", "suppressNotification": true, "impersonatedBy": "string", "createdTime": "2019-08-24T14:15:22Z", "finishedTime": "2019-08-24T14:15:22Z", "error": "string", "errorDetails": "string", "sessionId": "string", "resumedFromRunId": "666b0c5a-138f-4104-834e-8a1ebe30fa3b", "cloudRunExecutionId": "string", "lastHeartbeatTime": "2019-08-24T14:15:22Z", "costUsd": "string", "data": "string"}