Skip to content

Get one render

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

Return one render by its job public_id.

404 RESOURCE_NOT_FOUND when the render doesn’t exist OR its inputs don’t carry this principal’s tenant (mismatch and absence are indistinguishable — existence never leaks across tenants).

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

Successful Response

Media type application/json
RenderResponse

One render — the final artifact of a succeeded compose / edit job.

The render’s identity IS the originating job’s ULID public_id. inputs echoes the job’s request with raw S3 keys stripped upstream (presigned *_image_url siblings stand in for them).

object
public_id
required
Public Id

The originating job’s ULID public_id.

string
job_type
required
Job Type

The originating job type (UPPER_SNAKE).

string
origin
required
Origin

“compose” (product-to-model) or “edit” (swap).

string
image_url
required
Image Url

Short-lived presigned GET URL for the final render image.

string
inputs
Any of:
object
key
additional properties
any
created_at
required
Created At

Job creation timestamp (UTC).

string format: date-time
Example generated
{
"public_id": "example",
"job_type": "example",
"origin": "example",
"image_url": "example",
"inputs": {},
"created_at": "2026-04-15T12:00:00Z"
}

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"
}
]
}