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

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

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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