Escape para Conteúdo

Desenvolvedor API

Versão 1 Use os mesmos modelos, ativos, recuperação de tarefas e contabilidade de crédito como o Studio.

Gestão API chaves

Enviar Autorização: Bater YOUR_API_KEY. cookies do site não são aceitos como API A adesão ativa paga e a autorização-chave necessária são verificadas em cada solicitação.

Leia os modelos, carregue uma referência se necessário, solicite uma citação, reconheça explicitamente essa citação, e submete-a com uma chave de impotência estável.

Apenas a submissão de geração consome créditos de conta. Cotas e criação chave não consomem créditos. Fracções do fornecedor usam o processo de reembolso e reconciliação existente. Não submete uma nova chave de identidade enquanto o resultado original é desconhecido.

Cada chave permite 60 Requisitos autenticados por minuto. a 429 A resposta inclui Retry-After. as chaves expiram dentro 1–365 dias e pode ser revogada imediatamente.

HTTPURLPermissões
GET/api/v1/modelsmodels:read
GET/api/v1/assetsassets:read
GET/api/v1/assets/{id}/downloadassets:read
POST/api/v1/uploadsassets:write
PUT/api/v1/uploads/{id}assets:write
POST/api/v1/uploads/{id}/completeassets:write
POST/api/v1/quotesgenerations:write
POST/api/v1/generationsgenerations:write
GET/api/v1/generations/{kind}/{id}generations:read
GET/api/v1/generations/{kind}/{id}/outputs/{index}generations:read

As referências usam um upload de três passos: declarar MIME e tamanho de byte, PUT os bytes, depois completar. JPEG, PNG e WebP Para cima 10 Utilize o ID de ativo retornado; URLs de referência externos e outros ativos dos usuários não são aceitos.

// Node.js 22+; keep API_KEY on your server.
const base = process.env.API_BASE_URL;
const headers = {
  Authorization: `Bearer ${process.env.API_KEY}`,
  'Content-Type': 'application/json',
};
const modelsResponse = await fetch(base + '/api/v1/models', { headers });
if (!modelsResponse.ok) throw new Error('Read models failed');
const models = await modelsResponse.json();

const draft = {
  "kind": "image",
  "modelPreset": "gpt-image-2",
  "mode": "text-to-image",
  "prompt": "A yellow ceramic mug on a pale blue background",
  "aspectRatio": "1:1",
  "resolution": "1k",
  "outputCount": 1
};
const quoteResponse = await fetch(base + '/api/v1/quotes', {
  method: 'POST', headers, body: JSON.stringify({ draft }),
});
if (!quoteResponse.ok) throw new Error('Quote failed');
const quote = await quoteResponse.json();

// Review quote.quote before submitting. Persist this operation ID first.
const operationId = process.env.OPERATION_ID;
if (!operationId) throw new Error('A stable operation ID is required');
const submitted = await fetch(base + '/api/v1/generations', {
  method: 'POST',
  headers: { ...headers, 'Idempotency-Key': operationId },
  body: JSON.stringify({
    draft: quote.normalizedDraft,
    quoteAcknowledgement: quote.quote,
  }),
});
if (!submitted.ok) throw new Error('Check response before retrying');
const { task } = await submitted.json();
const taskResponse = await fetch(
  base + '/api/v1/generations/' + task.kind + '/' + task.id, { headers },
);
if (!taskResponse.ok) throw new Error('Read task failed');
const detail = await taskResponse.json();
// Poll at two-second intervals until terminal. Download detail.outputs[].downloadUrl
// with the same Authorization header. Never change the ID to retry an unknown outcome.

401• A chave falha, expirada ou revogada. 403- Falta de permissão ou participação paga. 409: conflito de impotência ou alteração da quota; solicitar e confirmar uma nova quota. 422A entrada é invalida. 429O limite de taxa. 503Leia o código de erro de resposta; nunca retire uma encomenda paga com uma nova chave automaticamente.