ai

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

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

Alle ai-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie links.edit beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt verwacht org_id als een veld in de JSON-body.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Parameters

NaamTypeVerplichtWat dit is
postId (path)UuidJa

Aanvraaglichaam

NaamTypeVerplichtWat dit is
featuredbooleanNee
inline_countintegerNee⛔ 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.
stylestringNeeWoven into every prompt — "photographic, no text overlay, muted palette".
providerAiImageProvider | string<>NeeLeave empty to let the platform choose.
modelstringNeeA specific `model_id` to pin, or empty to follow the provider's default.
target_localestringNeeThe language the post will be published in, so alt text is localised to the **site** rather than to the dashboard's UI locale.
org_idUuidNeeUUIDv7 identifier — sortable by creation time (docs/02 §8).

Reactie

NaamTypeVerplichtWat dit is
dataGeneratedImage[]Ja
unmetstring[]NeeWhat 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_htmlstringNeeThe post body with the generated images' placeholders written into it.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429