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.

Authorizations

• sk_*

Parameters

Path Parameters

public_id

required

Public Id

string

Header Parameters

X-Shopify-Hmac-Sha256

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/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 SUCCESS FAILURE IN_PROGRESS

created_at

required

Created At

Job creation timestamp (UTC).

string format: date-time

request

Any of:

object

object

key

additional properties

any

null

null

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; s3_key/asset_id are now also carried per D6 so the storefront image route can presign without extra lookup.

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

string

null

null

meta

Meta

Kind-specific metadata.

object

key

additional properties

any

s3_key

Any of:

string

string

null

null

asset_id

Any of:

string

string

null

null

latest_event

Any of:

JobEventResponse

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

string

null

null

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; s3_key/asset_id are now also carried per D6 so the storefront image route can presign without extra lookup.

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

string

null

null

meta

Meta

Kind-specific metadata.

object

key

additional properties

any

s3_key

Any of:

string

string

null

null

asset_id

Any of:

string

string

null

null

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

null

null

Example

{
  "status": "NOT_STARTED"
}

422

Validation Error

Media typeapplication/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"
    }
  ]
}