POST `/v1/ai/images/credentials`

Store an image-provider key for this organization.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.manage; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como um campo no corpo JSON.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`provider`	`AiImageProvider`	Sim	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`	Sim	The key itself. Written straight to Vault and never returned.
`label`	`string`	Não	—
`org_id`	`Uuid`	Não	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`provider`	`AiImageProvider`	Sim	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`	Sim	—
`verified_at`	`object`	Não	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`	Não	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`	Não	—
`last_check_error`	`string`	Não	The provider's own words when the last check failed. Empty otherwise.
`broken_since`	`object`	Não	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`	Não	—
`created_at`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 422 · 429