Jobs
Check the status of a job and retrieve its output when complete.
All Pixii API endpoints are asynchronous — they return a job_id immediately and process in the background. Use the Jobs API to check a job’s status and retrieve its output when complete. To look up jobs by ASIN, see List jobs.
Get a job
GET /v1/api/jobs/{job_id}Response fields
| Field | Type | Description |
|---|---|---|
id | string | Unique job identifier |
job_type | string | The type of job — e.g. Listing Builder or Scale |
status | string | Current job status — see below |
created_at | string | ISO 8601 timestamp when the job was submitted |
started_at | string | null | ISO 8601 timestamp when processing began |
completed_at | string | null | ISO 8601 timestamp when the job finished |
credit_cost | number | Credits charged for this job |
credits_refunded | number | Credits refunded if any images failed to generate |
output | object | null | Job output. null until status is completed |
error_code | string | null | Job error code when status is failed. See Job errors |
Job statuses
pending Job received and queued processing Job is actively running completed output is ready failed Job failed — check the error_code field Output
When status is completed, the output object contains an ads array — each item is one generated image. The shape of output is consistent across job types; the array length and contents depend on which endpoint produced the job.
| Field | Type | Description |
|---|---|---|
ads | array | Array of generated images |
ads[].preview_url | string | null | Signed URL to the generated image. Valid for 7 days. null if the image failed |
ads[].error | object | null | Error details if this specific image failed to generate. null on success |
ads[].error.code | string | Job error code — see Job errors |
ads[].error.message | string | Human-readable error message |
Partial failures — if some images fail while others succeed, the job status is still completed. Failed images have a non-null error field and a null preview_url. Credits are automatically refunded for any failed images — check credits_refunded on the job.
Signed image URLs expire 7 days after the job completes. Download and store the images before then.
Errors
| Code | HTTP | Description |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid API key |
JOB_NOT_FOUND | 404 | Job not found or does not belong to your organization |