Skip to main content
GET
Get a job
Poll this endpoint using an ID returned by a creation request. The pending states are pending and generating; the terminal states are completed, failed, and policy_blocked. On completion, result contains the media ID, type, URL, and dimensions. On failure, error contains a safe code and readable message. Keep the job ID when reporting an issue or resuming after a client timeout. credits_used is the current charge for this output in display credits: 1.5 means 1.5 Studio credits. Use the value directly. A completed refund is reflected as 0. Use and edit results →

Authorizations

Authorization
string
header
required

Create an API key in Studio → account menu → API Keys. Keep it on your server.

Path Parameters

id
string<uuid>
required

Source resource ID.

Response

Success

id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
generating,
completed,
failed,
policy_blocked
task
string | null
required

Processing task. This may be more specific than the submitted operation.

created_at
string<date-time>
required
result
object | null
required
error
object | null
required
credits_used
number
required

Credits currently charged for this output, in display credits: 1 means one Studio credit. Fractional amounts are preserved. A completed refund is reflected as 0 when polling. Creation and idempotency replay responses are snapshots; poll for the latest charge.

Required range: x >= 0
Example:

1.5