ai
POST /v1/ai/images/posts/{postId}
Generate a featured image and in-post images for a content post.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл links.edit; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоінт приймає org_id як поле в тілі JSON.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/ai/images/posts/{postId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Generates the images **and writes the `<img>` placeholders into the post body**, in one transaction. ⛔ Those are deliberately not two endpoints: one that generated images and left the body alone would produce rows in a table, nothing on a page, and a dashboard reporting success. Alt text is generated and stored in the source language and **localised to the destination site's language when the post is published** (§2.19) — one post goes to many sites, so the language is a property of the site, not of the draft. The response carries `unmet`: anything the chosen provider could not honour, in words for the customer. Nothing is silently dropped. Requires `links.edit`.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
postId (path) | Uuid | Так | — |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
featured | boolean | Ні | — |
inline_count | integer | Ні | ⛔ Bounded at 4. A hundred near-identical stock-looking images across a network **is a footprint**, which is the one thing the Footprint-Free line exists to avoid. |
style | string | Ні | Woven into every prompt — "photographic, no text overlay, 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. |
target_locale | string | Ні | The language the post will be published in, so alt text is localised to the **site** rather than to the dashboard's UI locale. |
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, so a client can tell "nothing was drop… |
body_html | string | Ні | The post body with the generated images' placeholders written into it. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429