API referenceOperations
Read an operation
Proposed operation. Returns authoritative asynchronous state, the immutable surface for surface-owned work, usage facts, terminal failure, and output locators when available. The surface is derived from operation_id; this endpoint has no surface selector. Polling is bounded by the client's chosen cadence; completion may also be delivered through signed at-least-once webhook events.
Authorization
bearerAuth AuthorizationBearer <token>
Organization-scoped bearer credential. Credentials are scoped, revocable, and never represented by a Soul or operation ID.
In: header
Path Parameters
operation_id*string
Company-scoped asynchronous operation identifier.
Match
^op_[A-Za-z0-9][A-Za-z0-9._:-]{0,126}$Length
1 <= length <= 128Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/operations/string"{ "operation_id": "string", "status": "accepted", "resource": { "type": "source_asset", "id": "string" }, "progress_percent": 0, "quote": { "quote_id": "string" }, "usage": { "reserved_gems": 0, "consumed_gems": 0, "released_gems": 0 }, "failure": { "code": "string", "message": "string", "retryable": true }, "output": { "kind": "text", "text": "string", "media": [ { "kind": "image", "url": "http://example.com" } ] }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": { "self": "http://example.com" }, "kind": "source_asset_validation"}