Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение links.edit; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/ai/images/library \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "prompt": <string> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
prompt | string | Да | 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> | Нет | ⛔ 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 | Нет | ⛔ 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 | Нет | Appended to the prompt — "photographic, muted palette". |
provider | AiImageProvider | string<> | Нет | Leave empty to let the platform choose. |
model | string | Нет | A specific `model_id` to pin, or empty to follow the provider's default. |
org_id | Uuid | Нет | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
data | GeneratedImage[] | Да | — |
unmet | string[] | Нет | What the chosen provider could not honour, in words for the customer. ⛔ Present and empty rather than absent when everything was honoured. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422 · 429