ai
POST /v1/ai/images/posts/{postId}
Generate a featured image and in-post images for a content post.
認証
ベアラー トークンとして API キーを送信します。キーには links.edit 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織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 | はい | — |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
featured | boolean | いいえ | — |
inline_count | integer | いいえ | ⛔ 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 | いいえ | Woven into every prompt — "photographic, no text overlay, muted palette". |
provider | AiImageProvider | string<> | いいえ | Leave empty to let the platform choose. |
model | string | いいえ | A specific `model_id` to pin, or empty to follow the provider's default. |
target_locale | string | いいえ | 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 | いいえ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | GeneratedImage[] | はい | — |
unmet | string[] | いいえ | 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 | いいえ | The post body with the generated images' placeholders written into it. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429