Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie links.edit beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt verwacht org_id als een veld in de JSON-body.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/ai/images/library \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "prompt": <string> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Draws up to four images from the customer's own prompt and keeps them in their library for 90 days. Requires `links.edit`. ⭐ This is the door that makes image generation a product rather than a post decoration. Every other image operation needs a content post to exist first; a hosting customer who wants a hero picture for their homepage, a social card or a product shot has none and never will. Billing is the **one AI meter** — BYO key first, then Zinn® credits, then whatever the plan includes; there is no separate image SKU. ⛔ A suspended account or one with no active subscription is refused before anything is drawn (§2.46), with `AI_NOT_IN_GOOD_STANDING` rather than the top-up message: that one is fixed by settling the account, and offering a credit button there sends the customer to a screen that cannot help them. The response carries `unmet` — anything the chosen provider could not honour, in words for the customer. Nothing is silently dropped.
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
prompt | string | Ja | Used **as written**, not rewritten into a template. The only thing added is an instruction to draw no lettering, because all three providers render garbled text when asked for w… |
shape | string<wide, standard, square> | Nee | ⛔ A word, not a pixel pair, and that is a portability property rather than a simplification: Google takes an aspect ratio and a size *bucket* and cannot be given `1536x864`; Ope… |
count | integer | Nee | ⛔ Bounded at 4 so one press cannot spend an unbounded amount of a customer's credit. Four is already more variations than anybody picks between. |
style | string | Nee | Appended to the prompt — "photographic, muted palette". |
provider | AiImageProvider | string<> | Nee | Leave empty to let the platform choose. |
model | string | Nee | A specific `model_id` to pin, or empty to follow the provider's default. |
org_id | Uuid | Nee | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
data | GeneratedImage[] | Ja | — |
unmet | string[] | Nee | What the chosen provider could not honour, in words for the customer. ⛔ Present and empty rather than absent when everything was honoured. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 422 · 429