ai

POST /v1/ai/images/credentials

Store an image-provider key for this organization.

ټول ai پای ټکي

ټول د پراختیا کونکي اسناد

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.payment.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی د JSON په متن کې د یوې ساحې په توګه org_id اخلي.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د 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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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.

د غوښتنې بدن

نومډولاړیندا څه شی دی
providerAiImageProviderهو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_keystringهوThe key itself. Written straight to Vault and never returned.
labelstringنه
org_idUuidنهUUIDv7 identifier — sortable by creation time (docs/02 §8).

ځواب

نومډولاړیندا څه شی دی
idUuidهوUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerAiImageProviderهو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…
labelstringهو
verified_atobjectنه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_atobjectنه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_okobjectنه
last_check_errorstringنهThe provider's own words when the last check failed. Empty otherwise.
broken_sinceobjectنه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_atobjectنه
created_atstringهو

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 422 · 429