Skip to content

Get one job's detail

GET
/v1/jobs/{public_id}
curl --request GET \
--url https://example.com/v1/jobs/example \
--header 'Authorization: Bearer <token>'

Return a job’s header, final result manifest, and latest public event.

404 JOB_NOT_FOUND when the job doesn’t exist OR belongs to another tenant.

public_id
required
Public Id
string
X-Shopify-Hmac-Sha256
Any of:
string

Successful Response

Media type application/json
JobDetailResponse

GET /v1/jobs/{id} — header + final result manifest + latest event.

object
public_id
required
Public Id

The job’s ULID public_id.

string
job_type
required
Job Type

The job’s type (UPPER_SNAKE).

string
status
required
JobStatus

The job’s current status.

string
Allowed values: NOT_STARTED IN_PROGRESS SUCCESS FAILURE
created_at
required
Created At

Job creation timestamp (UTC).

string format: date-time
request
Any of:
object
key
additional properties
any
result
Result

The final-artifact manifest (empty until the job succeeds).

Array<object>
ArtifactResponse

A job artifact — image_url is a short-lived presigned GET URL; a raw S3 key never crosses this boundary (studio AD-8).

object
image_url
required
Image Url

Short-lived presigned GET URL for the artifact image.

string
kind
required
Kind

Artifact kind, e.g. “on_model_render”, “catalog_image”.

string
role
required
Role

Intermediate | final.

string
label
Any of:
string
meta
Meta

Kind-specific metadata.

object
key
additional properties
any
latest_event
Any of:
JobEventResponse

One public-visibility event in a job’s timeline.

object
seq
required
Seq

Monotonic per-job sequence number — the polling cursor.

integer
event_type
required
Event Type

Queued | stage | succeeded | failed.

string
visibility
required
Visibility

Always ‘public’ on this surface.

string
stage
Any of:
string
message
required
Message

Human-readable event line.

string
artifacts
Artifacts

Presigned artifacts for this event.

Array<object>
ArtifactResponse

A job artifact — image_url is a short-lived presigned GET URL; a raw S3 key never crosses this boundary (studio AD-8).

object
image_url
required
Image Url

Short-lived presigned GET URL for the artifact image.

string
kind
required
Kind

Artifact kind, e.g. “on_model_render”, “catalog_image”.

string
role
required
Role

Intermediate | final.

string
label
Any of:
string
meta
Meta

Kind-specific metadata.

object
key
additional properties
any
extra
Extra

Type-specific payload fields (cost/error/etc.).

object
key
additional properties
any
created_at
required
Created At

Event creation timestamp (UTC).

string format: date-time
Example
{
"status": "NOT_STARTED"
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}