Documentació de l'API REST
API REST
Codis d'error
Tots els codis d'error que retorna l'API, amb el seu estat HTTP, què signifiquen i què cal fer.
La forma de l'error
Els errors són JSON amb aquesta forma. Ramifica pel code, que no canvia mai; el message és per a les persones i pot canviar. details llista cada camp no vàlid en un 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Codis
Enllaça directament a un codi amb el seu nom com a àncora, per exemple /docs/api/errors#rate_limited.
- 400invalid_request
- El cos, la consulta o una capçalera no són vàlids. details indica cada camp amb problemes. Corregeix la sol·licitud; reintentar-la sense canvis tornarà a fallar.
- 401api_key_expired
- La clau ha superat la seva data de caducitat. Crea una clau nova, o renova la clau per obtenir un secret nou.
- 401api_key_revoked
- La clau s'ha revocat. Crea una clau nova a Configuració › Desenvolupadors.
- 401invalid_api_key
- Cap clau coincideix. Comprova que has copiat la clau sencera, o crea'n una de nova a Configuració › Desenvolupadors.
- 402insufficient_credits
- S'han esgotat els crèdits d'IA del propietari de la clau. Recarrega o millora el pla a Attorly i torna-ho a provar.
- 402usage_limit_exceeded
- S'ha assolit un límit d'ús de la IA del propietari de la clau o de l'organització. Es restableix amb el període de facturació; un administrador de l'organització pot ampliar el límit d'un membre.
- 403ai_consent_withdrawn
- El propietari de la clau, o el del document, ha retirat el consentiment al tractament amb IA. Es pot tornar a donar a Configuració › Privadesa.
- 403forbidden
- La clau pot llegir el recurs però no canviar-lo, o l'acció no hi és permesa. Demana al propietari accés d'edició.
- 403insufficient_scope
- A la clau li falta un permís que necessita aquesta operació; el missatge el nomena. Crea una clau amb aquest permís.
- 403ip_not_allowed
- La clau té una llista d'IP permeses i la sol·licitud ha arribat des d'una adreça que no hi és. Fes la crida des d'una adreça permesa, o canvia la llista a Configuració › Desenvolupadors.
- 403plan_required
- El pla del propietari de la clau no inclou l'accés a l'API, o el propietari ha deixat l'organització. L'accés a l'API requereix Pro o Enterprise.
- 404not_found
- El recurs no existeix, o aquesta clau no el pot veure. Comprova l'id i que el propietari de la clau hi té accés.
- 405method_not_allowed
- La ruta no admet aquest mètode HTTP. La capçalera Allow llista els mètodes que admet.
- 409conflict
- La sol·licitud entra en conflicte amb l'estat actual del recurs, per exemple una acció que ja s'ha fet. Llegeix el recurs i decideix de nou.
- 409idempotency_request_in_progress
- Una sol·licitud amb la mateixa Idempotency-Key encara s'està executant. Consulta periòdicament la capçalera Location, o reintenta passats els segons de Retry-After.
- 413payload_too_large
- El cos o el fitxer pujat és massa gran. Els fitxers poden ser de fins a 10 MB.
- 415unsupported_media_type
- El cos té un format que aquesta operació no accepta. Envia JSON, o multipart/form-data allà on s'accepta una pujada.
- 422idempotency_key_reused
- La Idempotency-Key ja s'ha fet servir abans per a una sol·licitud diferent. Fes servir una clau nova per a cada sol·licitud diferent.
- 422unprocessable
- La sol·licitud és vàlida però no es pot dur a terme, per exemple una anàlisi d'un document sense llei aplicable triada. El missatge diu què falta.
- 429concurrency_limit_exceeded
- La teva organització ja executa tantes operacions d'IA de llarga durada alhora com pot. Espera que n'acabi una, o els segons de Retry-After, i reintenta.
- 429rate_limited
- Massa sol·licituds en una de les finestres en què compta aquesta clau. Espera el nombre de segons de Retry-After i reintenta. La capçalera RateLimit mostra quina finestra és plena.
- 500internal_error
- Alguna cosa ha fallat a Attorly. Reintenta amb la mateixa Idempotency-Key; si persisteix, contacta amb el suport amb el requestId.
- 504timeout
- L'operació no ha acabat a temps. Reintenta amb la mateixa Idempotency-Key, o envia Prefer: respond-async i consulta periòdicament l'operació.