POST `/v1/ai/images/credentials`

Store an image-provider key for this organization.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.payment.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تقبل هذه نقطة النهاية org_id حقلًا في نص JSON.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Puts the key in Vault and records a pointer. Any existing live key for the same provider is revoked in the same transaction. ⭐ The key is tested immediately, by generating a real image, and the result is on the response. An auth probe is green against a model id that no longer exists, so the only check worth returning is one that actually draws something. A key that does not work is still stored and still a 201 — the row records last_check_ok: false and the provider's own words in last_check_error, because "we saved it and it does not work" is the successful outcome of this request and a 4xx would leave the screen unable to say why. Requires billing.payment.manage.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`provider`	`AiImageProvider`	نعم	An image-generation provider. ⛔ Deliberately a different enum from the text `provider` on `AiCredential`: Anthropic publishes no image model and xAI publishes no text model we…
`api_key`	`string`	نعم	The key itself. Written straight to Vault and never returned.
`label`	`string`	لا	—
`org_id`	`Uuid`	لا	UUIDv7 identifier — sortable by creation time (docs/02 §8).

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`provider`	`AiImageProvider`	نعم	An image-generation provider. ⛔ Deliberately a different enum from the text `provider` on `AiCredential`: Anthropic publishes no image model and xAI publishes no text model we…
`label`	`string`	نعم	—
`verified_at`	`object`	لا	The last time a real image generation on this key succeeded. ⛔ `null` means never proven, not broken. Moved only by a generation, never by a cheap auth probe: a probe proves…
`last_checked_at`	`object`	لا	The last time any check ran, pass or fail. Separate from `verified_at` so "we have not looked recently" is distinguishable from "we looked and it failed".
`last_check_ok`	`object`	لا	—
`last_check_error`	`string`	لا	The provider's own words when the last check failed. Empty otherwise.
`broken_since`	`object`	لا	When the key first failed after last passing, or `null` if it is not currently broken. ⭐ This is what makes "notify on transition to broken, never per check" possible — a key…
`last_used_at`	`object`	لا	—
`created_at`	`string`	نعم	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 422 · 429