POST `/v1/ai/images/credentials`

Store an image-provider key for this organization.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền billing.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.

Nơi điền id tổ chức của bạn

Endpoint này nhận org_id làm một trường trong phần thân JSON.

Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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> }'

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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.manage`.

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`provider`	`AiImageProvider`	Có	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 u…
`api_key`	`string`	Có	The key itself. Written straight to Vault and never returned.
`label`	`string`	Không	—
`org_id`	`Uuid`	Không	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`provider`	`AiImageProvider`	Có	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 u…
`label`	`string`	Có	—
`verified_at`	`object`	Không	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`	Không	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`	Không	—
`last_check_error`	`string`	Không	The provider's own words when the last check failed. Empty otherwise.
`broken_since`	`object`	Không	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 br…
`last_used_at`	`object`	Không	—
`created_at`	`string`	Có	—

Các lỗi điểm cuối này có thể trả về

401 · 403 · 422 · 429