ai

GET /v1/ai/images/library/{imageId}/file

Download the image bytes.

All ai endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/ai/images/library/{imageId}/file \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The image itself, as an attachment. Requires `sites.view`. ⛔⛔ **This is how the customer gets the thing they paid for.** A standalone image has no WordPress post to be written into, so without this endpoint it is a row in a table and a charge on a meter. ⭐ Streamed through the engine rather than handed out as a presigned link: a signature that expires while the screen is open is a broken thumbnail with no explanation. ⛔ `404` once the 90-day retention has taken the object, which is not an error on anybody's part.

Parameters

NameTypeRequiredWhat it is
imageId (path)UuidYes
org_id (query)UuidNo

Errors this endpoint can return

401 · 403 · 404 · 429