ai
POST /v1/ai/images/posts/{postId}
Generate a featured image and in-post images for a content post.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão links.edit; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como um campo no corpo JSON.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/ai/images/posts/{postId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
postId (path) | Uuid | Sim | — |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
featured | boolean | Não | — |
inline_count | integer | Não | ⛔ 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 | Não | Woven into every prompt — "photographic, no text overlay, muted palette". |
provider | AiImageProvider | string<> | Não | Leave empty to let the platform choose. |
model | string | Não | A specific `model_id` to pin, or empty to follow the provider's default. |
target_locale | string | Não | 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 | Não | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
data | GeneratedImage[] | Sim | — |
unmet | string[] | Não | 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 | Não | The post body with the generated images' placeholders written into it. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429