POST `/v1/ai/images/library`

Generate images from a prompt, with no post involved.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה links.edit; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Draws up to four images from the customer's own prompt and keeps them in their library for 90 days. Requires `links.edit`. ⭐ This is the door that makes image generation a product rather than a post decoration. Every other image operation needs a content post to exist first; a hosting customer who wants a hero picture for their homepage, a social card or a product shot has none and never will. Billing is the **one AI meter** — BYO key first, then Zinn® credits, then whatever the plan includes; there is no separate image SKU. ⛔ A suspended account or one with no active subscription is refused before anything is drawn (§2.46), with `AI_NOT_IN_GOOD_STANDING` rather than the top-up message: that one is fixed by settling the account, and offering a credit button there sends the customer to a screen that cannot help them. The response carries `unmet` — anything the chosen provider could not honour, in words for the customer. Nothing is silently dropped.

גוף הבקשה

שם	סוג	נדרש	מה זה
`prompt`	`string`	כן	Used as written, not rewritten into a template. The only thing added is an instruction to draw no lettering, because all three providers render garbled text when asked for w…
`shape`	`string<wide, standard, square>`	לא	⛔ A word, not a pixel pair, and that is a portability property rather than a simplification: Google takes an aspect ratio and a size bucket and cannot be given `1536x864`; Ope…
`count`	`integer`	לא	⛔ Bounded at 4 so one press cannot spend an unbounded amount of a customer's credit. Four is already more variations than anybody picks between.
`style`	`string`	לא	Appended to the prompt — "photographic, 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.
`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.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 422 · 429