Documentación da API REST
API REST
Códigos de erro
Todos os códigos de erro que devolve a API, co seu estado HTTP, o que significan e o que facer ao respecto.
A forma do erro
Os erros son JSON con esta forma. Ramifica sobre code, que nunca cambia; message é para as persoas e pode cambiar. details enumera cada campo non válido nun 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Códigos
Liga directamente a un código usando o seu nome como áncora, por exemplo /docs/api/errors#rate_limited.
- 400invalid_request
- O corpo, a consulta ou unha cabeceira non é válido. details nomea cada campo con problemas. Corrixe a solicitude; se a repites sen cambios, falla de novo.
- 401api_key_expired
- A chave superou a súa data de caducidade. Crea unha chave nova, ou renova a chave para obter un segredo novo.
- 401api_key_revoked
- A chave foi revogada. Crea unha chave nova en Configuración › Desenvolvedores.
- 401invalid_api_key
- Ningunha chave coincide. Comproba que copiaches a chave completa, ou crea unha nova en Configuración › Desenvolvedores.
- 402insufficient_credits
- Esgotáronse os créditos de IA do propietario da chave. Recarga ou mellora o plan en Attorly e volve tentalo.
- 402usage_limit_exceeded
- Alcanzouse un límite de uso de IA do propietario da chave ou da organización. Restablécese co período de facturación; un administrador da organización pode aumentar o límite dun membro.
- 403ai_consent_withdrawn
- O propietario da chave, ou o propietario do documento, retirou o consentimento para o tratamento con IA. Pódese volver outorgar en Configuración › Privacidade.
- 403forbidden
- A chave pode ler o recurso pero non cambialo, ou a acción non lle está permitida. Pide ao propietario acceso de edición.
- 403insufficient_scope
- A chave carece dun permiso que precisa esta operación; a mensaxe nomeao. Crea unha chave con ese permiso.
- 403ip_not_allowed
- A chave ten unha lista de enderezos IP permitidos e a solicitude veu dun enderezo fóra dela. Chama desde un enderezo permitido, ou cambia a lista en Configuración › Desenvolvedores.
- 403plan_required
- O plan do propietario da chave non inclúe o acceso á API, ou o propietario abandonou a organización. O acceso á API require Pro ou Enterprise.
- 404not_found
- O recurso non existe, ou esta chave non pode velo. Comproba o id e que o propietario da chave ten acceso.
- 405method_not_allowed
- A ruta non admite este método HTTP. A cabeceira Allow enumera os métodos que si admite.
- 409conflict
- A solicitude entra en conflito co estado actual do recurso, por exemplo unha acción que xa se fixo. Le o recurso e decide de novo.
- 409idempotency_request_in_progress
- Unha solicitude coa mesma Idempotency-Key aínda se está executando. Consulta a cabeceira Location, ou repite despois dos segundos de Retry-After.
- 413payload_too_large
- O corpo ou o ficheiro cargado é demasiado grande. Os ficheiros poden ter ata 10 MB.
- 415unsupported_media_type
- O corpo está nun formato que esta operación non acepta. Envía JSON, ou multipart/form-data onde se acepta unha carga.
- 422idempotency_key_reused
- A Idempotency-Key usouse antes para unha solicitude diferente. Usa unha chave nova para cada solicitude distinta.
- 422unprocessable
- A solicitude é válida pero non se pode realizar, por exemplo unha análise dun documento sen lei aplicable escollida. A mensaxe indica o que falta.
- 429concurrency_limit_exceeded
- A túa organización xa executa tantas operacións de IA de longa duración como pode á vez. Agarda a que remate unha, ou os segundos de Retry-After, e volve tentalo.
- 429rate_limited
- Demasiadas solicitudes nunha das xanelas nas que conta esta chave. Agarda os segundos de Retry-After e volve tentalo. A cabeceira RateLimit mostra que xanela está chea.
- 500internal_error
- Algo saíu mal en Attorly. Repite coa mesma Idempotency-Key; se persiste, contacta coa asistencia co requestId.
- 504timeout
- A operación non rematou a tempo. Repite coa mesma Idempotency-Key, ou envía Prefer: respond-async e consulta a operación.