Skip to main content

Endpoint

Requires content:render for scoped keys. The bearer key selects the organization; an optional ?orgId=YOUR_ORG_ID query must identify an authorized organization. Only jobs owned by that organization can be queried.

Request body

string
required
The UUID returned by Render iMessage Conversation. Unknown fields are rejected.

TypeScript

HTTP

Job lifecycle

Use a bounded polling loop with a delay, rather than continuously requesting status. The usage guide shows a complete example that handles failure and cancellation. Add a caller-side deadline if your application needs to stop polling after a set interval. A successful status request is HTTP 200 even when the job itself is failed or cancelled; inspect data.status.

Response

Raw HTTP returns { "code": 200, "data": { ... } }; the SDK normalizes that to an ApiResponse with ok: true and message. The data object is the same IMessageConversationJob returned by submission and cancellation.
The example UUID and URL are illustrative, not an existing download. durationMs describes the authored timeline. For PNG output, durationInFrames is 1, while durationMs still describes the conversation.

Errors

Ownership records expire after seven days. A 404 intentionally does not reveal whether a job exists in another organization.