ai

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

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

所有 ai 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 links.edit 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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

参数

名称类型必填内容简介
postId (path)Uuid

请求正文

名称类型必填内容简介
featuredboolean
inline_countinteger⛔ 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.
stylestringWoven into every prompt — "photographic, no text overlay, muted palette".
providerAiImageProvider | string<>Leave empty to let the platform choose.
modelstringA specific `model_id` to pin, or empty to follow the provider's default.
target_localestringThe language the post will be published in, so alt text is localised to the **site** rather than to the dashboard's UI locale.
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).

响应

名称类型必填内容简介
dataGeneratedImage[]
unmetstring[]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_htmlstringThe post body with the generated images' placeholders written into it.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429