POST `/v1/ai/images/library`

Generate images from a prompt, with no post involved.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (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

التفاصيل

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