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