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

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung links.edit verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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

Parameter

Name	Typ	Erforderlich	Was es ist
`postId (path)`	`Uuid`	Ja	—

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`featured`	`boolean`	Nein	—
`inline_count`	`integer`	Nein	⛔ 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`	Nein	Woven into every prompt — "photographic, no text overlay, muted palette".
`provider`	`AiImageProvider \| string<>`	Nein	Leave empty to let the platform choose.
`model`	`string`	Nein	A specific `model_id` to pin, or empty to follow the provider's default.
`target_locale`	`string`	Nein	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`	Nein	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Antwort

Name	Typ	Erforderlich	Was es ist
`data`	`GeneratedImage[]`	Ja	—
`unmet`	`string[]`	Nein	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`	Nein	The post body with the generated images' placeholders written into it.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429