Skip to main content

Get Agent Status

1 min read
get/agent/{jobId}
Request example
Response
get/agent/{jobId}

Authorization

Authorizationstringheaderrequired#
Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Path parameters

jobIdstringrequired#
The ID of the agent job

Responses

application/json
Successful response
successboolean#
statusenum<string>#
Options:processingcompletedfailed
dataobject#
The extracted data (only present when status is completed)
modelenum<string>#
Model preset used for the agent run. Every new run executes on spark-2; Spark 1 names only appear on legacy runs.

Default: "spark-2"

Options:spark-2spark-1-prospark-1-mini
effortenum<string>#
Reasoning budget used for the agent run (only present for runs that set effort)
Options:lowmediumhigh
errorstring#
Error message (only present when status is failed)
expiresAtstring#
creditsUsednumber#