Fetch a product image

get

https://myapi.xegora.com/api/v1/catalog-product-images/{publicReference}

Streams the image binary behind an opaque img_… public reference from a product's images/imageUrl fields. Same-origin, same X-Api-Key authentication, products.read scope. References are stable for the life of the image and safe to use as cache keys. Serve images to end users from your own infrastructure — never expose your key in a browser. Image requests are counted against a budget of their own, 300 per minute per workspace, so they never spend the 120 requests per minute the rest of the API shares.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

publicReference

string

required

^img_[0-9a-f]{32}$

img_ followed by 32 lowercase hex characters; anything else is 404.

Headers

If-None-Match

string

Previously returned ETag; a matching image returns 304 after checking workspace access.

X-Correlation-Id

string

length ≤ 128

^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

X-Language

string

enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

304

The image is unchanged; no response body. Keep caches scoped to the authenticated workspace.

200The image bytes.

401No valid API key (code = unauthorized): missing, malformed, unknown, revoked or expired, or a wrong secret. The message is worded for an API key — this surface has no session to sign in to.

404No such resource in this workspace, or no such route (code = not_found).

503Images are temporarily unavailable (code = media_unavailable). Retry after the delay.