POST `/v1/ai/images/library`

Generate images from a prompt, with no post involved.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão links.edit; 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/library \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "prompt": <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

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.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`prompt`	`string`	Sim	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>`	Não	⛔ 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`	Não	⛔ 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`	Não	Appended to the prompt — "photographic, muted palette".
`provider`	`AiImageProvider \| string<>`	Não	Leave empty to let the platform choose.
`model`	`string`	Não	A specific `model_id` to pin, or empty to follow the provider's default.
`org_id`	`Uuid`	Não	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Resposta

Nome	Tipo	Obrigatório	O que é
`data`	`GeneratedImage[]`	Sim	—
`unmet`	`string[]`	Não	What the chosen provider could not honour, in words for the customer. ⛔ Present and empty rather than absent when everything was honoured.

Erros que este endpoint pode retornar

401 · 403 · 422 · 429