ai
GET /v1/ai/images/providers
Which image providers this organisation can actually generate with.
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/providers \
-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
Whether each provider can draw **right now, for this org**, and a machine-readable `reason` when it cannot. Requires `sites.view`. ⚖️ Owner ruling 2026-08-20 — *"declare capabilities; warn BEFORE they pick"*. That was built for a model's capabilities and never for the provider itself, which is the coarser and far more expensive version of the same question. Measured on production 2026-08-21: the live picker offered **OpenAI** and **xAI Grok** as ordinary enabled choices and both answered `422` on every request, because the estate holds a key for neither and no customer key could promote a model on its own. ⛔ `reason` is a **code**, never a sentence — `no_key`, `no_model`, `key_broken`, or empty when usable. Every string a customer reads is translated into 57 languages (§2.19), so a message assembled in the engine is an English message on a German screen. ⛔ `usable` and `key_broken` are independent. With platform credits behind it, a provider whose customer key has failed its last check is still usable — and the customer still needs telling, which is why both fields travel.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AiImageProviderAvailability[] | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429