Pular para o conteúdo

Erros

Toda resposta de erro da API usa o status HTTP adequado e retorna um corpo JSON consistente. Independente do tipo de erro, o corpo sempre tem dois campos: error e code.

{
"error": "Invalid or missing API token",
"code": "unauthorized"
}
CampoTipoDescrição
errorstringMensagem legível descrevendo o erro (sempre em inglês).
codestringCódigo estável e legível por máquina. Use este campo na sua lógica de tratamento de erros.
codeStatus HTTP típicoQuando acontece
invalid_request400Corpo malformado, campos ausentes ou inválidos, ou ID que não é UUID.
unauthorized401Token ausente, inválido ou revogado. Veja Autenticação.
forbidden403O token não tem permissão para acessar aquele recurso.
not_found404Recurso não existe ou pertence a outra organização.
conflict409A operação conflita com o estado atual — por exemplo, tentar editar um item de base com source='file' ou um item que está em processamento.
rate_limited429Limite de requisições excedido.
internal_error500Erro inesperado no servidor.

A API retorna os seguintes status HTTP:

StatusSignificado
200 OKRequisição bem-sucedida com corpo de resposta.
201 CreatedRecurso criado com sucesso.
202 AcceptedRequisição aceita e processando de forma assíncrona.
204 No ContentRequisição bem-sucedida sem corpo de resposta (ex.: exclusão).
400 Bad RequestDados da requisição inválidos ou malformados.
401 UnauthorizedToken ausente ou inválido.
403 ForbiddenToken válido, mas sem permissão para o recurso.
404 Not FoundRecurso não encontrado.
408 Request TimeoutTimeout no chat síncrono — o agente não respondeu a tempo.
409 ConflictEstado atual do recurso impede a operação.
429 Too Many RequestsLimite de requisições excedido.
500 Internal Server ErrorErro inesperado no servidor.