Saltar para o conteúdo principal
Documentação da API REST

API REST

Códigos de erro

Todos os códigos de erro que a API devolve, com o estado HTTP, o que significam e o que fazer.

A forma de um erro

Os erros são JSON com esta forma. Baseie a lógica em code, que nunca muda; message é para pessoas e pode mudar. details lista cada campo inválido num 400.

json
{
  "error": {
    "code": "insufficient_scope",
    "message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
    "requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
  }
}

Códigos

Crie uma ligação direta para um código usando o nome como âncora, por exemplo /docs/api/errors#rate_limited.

400invalid_request
O corpo, a consulta ou um cabeçalho é inválido. details indica cada campo com problemas. Corrija o pedido; repetido sem alterações, volta a falhar.
401api_key_expired
A chave ultrapassou a data de validade. Crie uma nova chave, ou renove-a para obter um novo segredo.
401api_key_revoked
A chave foi revogada. Crie uma nova chave em Definições › Programadores.
401invalid_api_key
Nenhuma chave corresponde. Verifique se a chave foi copiada por inteiro, ou crie uma nova em Definições › Programadores.
401unauthorized
O cabeçalho Authorization falta, ou não é a palavra Bearer seguida da chave. Envie a chave como token Bearer.
402insufficient_credits
Os créditos de IA do titular da chave esgotaram-se. Carregue ou mude de plano no Attorly e tente novamente.
402usage_limit_exceeded
Foi atingido um limite de utilização de IA do titular da chave ou da organização. É reposto com o período de faturação; um administrador da organização pode aumentar o limite de um membro.
403forbidden
A chave pode ler o recurso, mas não alterá-lo, ou a ação não é permitida. Peça ao proprietário acesso de edição.
403insufficient_scope
Falta à chave um âmbito de que esta operação precisa; a mensagem indica-o. Crie uma chave com esse âmbito.
403ip_not_allowed
A chave tem uma lista de IP permitidos e o pedido veio de um endereço fora dela. Faça a chamada a partir de um endereço permitido ou altere a lista em Definições › Programadores.
403plan_required
O plano do titular da chave não inclui acesso à API, ou o titular saiu da organização. O acesso à API requer Pro ou Enterprise.
404not_found
O recurso não existe, ou esta chave não o consegue ver. Verifique o id e se o titular da chave tem acesso.
405method_not_allowed
O caminho não suporta este método HTTP. O cabeçalho Allow lista os métodos suportados.
409conflict
O pedido entra em conflito com o estado atual do recurso, por exemplo uma ação já realizada. Leia o recurso e decida de novo.
409idempotency_request_in_progress
Um pedido com a mesma Idempotency-Key ainda está em curso. Consulte o cabeçalho Location, ou tente novamente após Retry-After segundos.
413payload_too_large
O corpo ou o ficheiro carregado é demasiado grande. Os ficheiros podem ter até 10 MB.
415unsupported_media_type
O corpo está num formato que esta operação não aceita. Envie JSON, ou multipart/form-data onde o carregamento é aceite.
422idempotency_key_reused
A Idempotency-Key já foi usada noutro pedido. Use uma chave nova para cada pedido diferente.
422unprocessable
O pedido é válido, mas não pode ser executado, por exemplo a análise de um documento sem lei aplicável escolhida. A mensagem diz o que falta.
429concurrency_limit_exceeded
A sua organização já executa tantas operações de IA de longa duração em simultâneo quanto pode. Aguarde que uma termine, ou os segundos indicados em Retry-After, e tente novamente.
429rate_limited
Demasiados pedidos numa das janelas em que esta chave conta. Aguarde os segundos indicados em Retry-After e tente novamente. O cabeçalho RateLimit mostra qual a janela cheia.
500internal_error
Algo correu mal no Attorly. Tente novamente com a mesma Idempotency-Key; se persistir, contacte o suporte com o requestId.
504timeout
A operação não terminou a tempo. Tente novamente com a mesma Idempotency-Key, ou envie Prefer: respond-async e consulte a operação.