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

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

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز links.edit باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت می‌کند.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی 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