Erros

Todo erro tem a forma:

{
  "error": {
    "type": "validation_error",
    "code": "invalid_request",
    "message": "due_date must be a valid ISO-8601 datetime",
    "request_id": "req_6a2918cff58b0a1d387866ee",
    "errors": [{ "field": "due_date", "message": "must be a valid ISO-8601 datetime" }]
  }
}

• type — uma categoria ampla e estável.
• code — uma string estável e legível por máquina.
• request_id — cite isto ao entrar em contato com o suporte.
• errors[] — detalhes por campo para falhas de validação (presente apenas quando relevante).

Catálogo

HTTP	type	code	Significado
401	authentication_error	unauthorized, expired	Chave de API ausente, inválida, revogada ou expirada.
403	permission_error	insufficient_scope	A chave não tem o acesso necessário, ou o recurso está fora de seu escopo.
404	not_found_error	resource_not_found	O recurso não existe ou não é visível para esta chave.
409	conflict_error	already_exists	O recurso já existe, ou uma Idempotency-Key foi reutilizada com um corpo de requisição diferente.
422	validation_error	invalid_request	A requisição falhou na validação; veja errors[] para os campos problemáticos.
429	rate_limit_error	too_many_requests	Requisições em excesso; tente novamente após o atraso indicado no cabeçalho Retry-After.
500	api_error	internal_error	Erro inesperado do servidor; é seguro tentar novamente mais tarde.

As respostas de erro também carregam um doc_url apontando de volta para esta página.