ai

POST /v1/ai/images/posts/{postId}

Generate a featured image and in-post images for a content post.

Tutti gli endpoint ai

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione links.edit; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come campo nel corpo JSON.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X POST https://api.zinndigital.com/v1/ai/images/posts/{postId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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`.

Parametri

NomeTipoObbligatorioChe cos'è
postId (path)Uuid

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
featuredbooleanNo
inline_countintegerNo⛔ 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.
stylestringNoWoven into every prompt — "photographic, no text overlay, muted palette".
providerAiImageProvider | string<>NoLeave empty to let the platform choose.
modelstringNoA specific `model_id` to pin, or empty to follow the provider's default.
target_localestringNoThe language the post will be published in, so alt text is localised to the **site** rather than to the dashboard's UI locale.
org_idUuidNoUUIDv7 identifier — sortable by creation time (docs/02 §8).

Risposta

NomeTipoObbligatorioChe cos'è
dataGeneratedImage[]
unmetstring[]NoWhat 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_htmlstringNoThe post body with the generated images' placeholders written into it.

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429