Skip to main content
GET
Get an operation

Authorizations

Authorization
string
header
required

A workspace API key from Settings → Developers → API keys, sent as Authorization: Bearer sk_… (or X-API-Key: sk_…). It acts as one workspace member and uses the workspace's credits.

Path Parameters

invocationId
string<uuid>
required

Query Parameters

result
enum<string>

full returns a result larger than 1 MiB inline.

Available options:
full

Response

The call ended and the tool succeeded (ok: true).

status
enum<string>
required

completed: the tool ran (ok says whether it succeeded). in_progress: still running. not_executed: nothing ran and nothing was charged. unknown_outcome: the tool may have run; do not run it again automatically.

Available options:
completed,
in_progress,
not_executed,
unknown_outcome
ok
boolean
required
invocationId
string<uuid>

The operation's id. Keep it.

toolId
string
result
any

The tool's output, when ok is true and it is under 1 MiB.

resultRef
object

Present instead of result when the output is over 1 MiB. Fetch it with ?result=full.

error
object
billing
object
replayed
boolean

true when this answer repeats an earlier request with the same key.

chargedThisRequest
number

Credits charged by this request; 0 on a replay.

recovery
object

For media generation only: how to recover the result of an unknown_outcome.