Skip to main content
GET
/
images
/
{job_id}
Get image job status
curl --request GET \
  --url https://api.budgetpixel.com/v1/images/{job_id} \
  --header 'Authorization: Bearer <token>'
{
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "images": [
    {
      "url": "<string>"
    }
  ],
  "job_id": 123,
  "model_name": "<string>",
  "num_images": 123,
  "prompt": "<string>",
  "started_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Path Parameters

​
job_id
integer
required

Response

Current job status. images is populated once succeeded.

​
completed_at
string<date-time>
​
created_at
string<date-time>
​
error
string
​
images
object[]

Generated images; present once status=succeeded.

​
job_id
integer
​
model_name
string
​
num_images
integer
​
prompt
string
​
started_at
string<date-time>
​
status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

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