ai
POST /v1/ai/images/posts/{postId}
Generate a featured image and in-post images for a content post.
Authentication
Send an API key as a bearer token. The key must carry the links.edit permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/ai/images/posts/{postId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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
| Name | Type | Required | What it is |
|---|---|---|---|
postId (path) | Uuid | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
featured | boolean | No | — |
inline_count | integer | No | ⛔ 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 | No | Woven into every prompt — "photographic, no text overlay, muted palette". |
provider | AiImageProvider | string<> | No | Leave empty to let the platform choose. |
model | string | No | A specific `model_id` to pin, or empty to follow the provider's default. |
target_locale | string | No | 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 | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | GeneratedImage[] | Yes | — |
unmet | string[] | No | 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 | No | The post body with the generated images' placeholders written into it. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429