API Reference

Endpoints acessíveis via X-API-Key. Todos retornam JSON no envelope padrão.

Autenticação

Inclua o header X-API-Key em todas as requisições:

// Header obrigatórioX-API-Key: obk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Gerencie suas chaves em Dashboard → API Keys.

Todas as respostas seguem o envelope padrão:

{ "success": true, "data": { ... }, "meta": { "request_id": "uuid", "format": "json" }}

Em caso de erro:

{ "success": false, "error": { "code": "not_found", "message": "Series not found" }, "meta": { "request_id": "uuid" }}

Código	Descrição
`200`	Sucesso
`202`	Série em descoberta/ingestão — tente novamente após retry_after segundos
`400`	Parâmetros inválidos
`401`	API key ausente ou inválida
`403`	Email não verificado ou permissão insuficiente
`404`	Série não encontrada
`422`	Erro de validação
`429`	Limite de requisições excedido