Skip to main content
GET
Get image job status

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Path Parameters

job_id
string
required

The opaque job id returned by the create endpoint (e.g. img_...).

Response

Current job status. images is populated once succeeded.

completed_at
string<date-time>

When the job finished. Present once status is succeeded, failed or timeout.

created_at
string<date-time>

When the job was submitted.

error
string
expired
boolean

Present once status=succeeded. true after expires_at; no URLs are returned then.

expires_at
string<date-time>

Present once status=succeeded. When the outputs are deleted, 24 hours after created_at.

id
string
Example:

"img_a1b2c3d4e5f6"

images
object[]

Generated images as signed URLs, each valid for at least 6 hours (call this endpoint again for fresh ones). Present once status=succeeded; empty once expired is true.

model
string
prompt
string

The prompt exactly as you submitted it.

started_at
string<date-time>

When processing started, i.e. when the job left the queue (started_at minus created_at is the queue time). If the job was retried, the start of the latest attempt.

status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

Available options:
pending,
starting,
processing,
completing,
succeeded,
failed,
timeout