OpenAPI e índice de endpoints

O contrato público legível por máquina está disponível em OpenAPI 3.1 YAML. Use-o para gerar um cliente ou validar sua integração com os endpoints públicos atuais.

Essas APIs da plataforma permitem selecionar modelos, obter estimativas e acompanhar gastos sem abrir o Console. O catálogo de modelos inclui os preços da conta; quando o preço depende dos parâmetros, solicite um orçamento com as entradas exatas. O histórico de tarefas e o uso ficam restritos à chave de API usada na chamada. A criação e a rotação de chaves e as configurações de orçamento continuam no Console. Cada tabela tem links para o guia que explica o endpoint por completo.

Descoberta de modelos, preços e APIs da conta

APIs de geração e tarefas

APIs de mídia

Autenticação e formato das respostas

Todos os endpoints, exceto o catálogo público, exigem sua chave de API como Authorization: Bearer sk-spicy-…; os endpoints de compatibilidade (/v1, /v1beta) também aceitam x-api-key, enviado pelos SDKs da Anthropic, e x-goog-api-key, enviado pelos SDKs Google GenAI. Nunca é aceita uma chave nos parâmetros de consulta da URL. Tarefas, novas tentativas, exclusões de conteúdo e links de download só ficam visíveis para a chave de API que criou a tarefa; veja Autenticação.

As respostas JSON da API de tarefas compartilham o envelope {code,msg,data,request_id}; os endpoints de compatibilidade usam o formato dos respectivos protocolos. O resultado de uma tarefa é indicado por data.state, não pelo code do envelope. Veja Erros.

Cabeçalhos de solicitação compartilhados entre endpoints

Como usar o arquivo OpenAPI

• Experimentar solicitações sem escrever código: importe o arquivo OpenAPI indicado no início desta página em um cliente de API, como Postman, Insomnia ou Bruno, e configure sua chave de API como token Bearer. Lembre-se de que criar tarefas custa dinheiro.
• Gerar um cliente: forneça o mesmo arquivo a um gerador de código OpenAPI 3.1 para sua linguagem.

Mudanças no contrato

• Não mantenha uma cópia fixa dos parâmetros dos modelos no código como referência permanente; consulte inputSchema em /models/{model}.
• Aceite campos desconhecidos nas respostas, mas nunca invente campos desconhecidos nas solicitações.
• Use o OpenAPI YAML na geração de código ou em testes de contrato antes de publicar.

Endpoints de compatibilidade

Os endpoints de texto são explicados em Texto e streaming; sua cobrança está em Orçamentos e compatibilidade.

O pacote oficial de TypeScript é @spicyapi/sdk. Para Python e Go, ou quando você não pode adicionar uma dependência, os clientes de referência abaixo podem ser copiados e chamam esses endpoints usando apenas o ambiente de execução da linguagem. O de Python realiza todo o fluxo de uma tarefa de mídia: enviar e confirmar um arquivo de referência, confirmar o preço com um orçamento, criar a tarefa e consultá-la até um estado final, ler o resultado em arquivos ou texto, renovar um link de saída expirado, destruir o conteúdo armazenado depois e verificar uma assinatura de webhook. O de Go cobre o mesmo fluxo, com contexto em todas as chamadas e um erro tipado recuperável por errors.As. O de TypeScript cobre criação de tarefas, novas tentativas, consulta de status e espera com limite; para uploads e os demais recursos em Node.js, use o SDK.

Clientes de referência copiáveis

Exemplos sem dependências para descobrir modelos, criar tarefas, repetir tarefas com falha, consultar todos os estados finais, limitar a espera e tratar idempotência e erros. Uma tarefa aceita não pode ser cancelada.

Cliente TypeScript de referênciaCliente Python de referênciaCliente Go de referênciaREADME

São exemplos da documentação, não pacotes npm ou PyPI nem módulos Go publicados. Dez minutos é um limite local, não um SLA.