Skip to main content
GET
Get a job
Poll with a bounded interval while the status is pending or generating. On completed, read result.url; use result.image_id from an image result as the source for another image operation. Video result IDs cannot be used as image sources. On failed or policy_blocked, stop and read error.code. The result is null until a completed media URL is available. Upload IDs are source images, so use Get an image to inspect those.

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

Job ID returned by creation.

Response

Current job state.

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