API REST

Coduri de eroare

Name: Attorly AI
Availability: InStock

Toate codurile de eroare returnate de API, cu starea HTTP, semnificația și ce trebuie făcut.

Forma unei erori

Erorile sunt JSON cu această formă. Construiți logica pe code, care nu se schimbă niciodată; message este pentru oameni și se poate schimba. details listează fiecare câmp invalid la un 400.

json

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

Coduri

Trimiteți direct la un cod folosind numele lui ca ancoră, de exemplu /docs/api/errors#rate_limited.

400invalid_request: Corpul, interogarea sau un antet nu este valid. details numește fiecare câmp cu probleme. Corectați cererea; trimisă neschimbată va eșua din nou.
401api_key_expired: Cheia a expirat. Creați o cheie nouă sau înlocuiți-o pentru a primi un secret nou.
401api_key_revoked: Cheia a fost revocată. Creați o cheie nouă în Setări › Dezvoltatori.
401invalid_api_key: Nicio cheie nu se potrivește. Verificați dacă ați copiat cheia completă sau creați una nouă în Setări › Dezvoltatori.
401unauthorized: Antetul Authorization lipsește sau nu este cuvântul Bearer urmat de cheie. Trimiteți cheia ca token Bearer.
402insufficient_credits: Creditele IA ale proprietarului cheii s-au epuizat. Reîncărcați sau schimbați planul în Attorly, apoi încercați din nou.
402usage_limit_exceeded: A fost atinsă o limită de utilizare IA a proprietarului cheii sau a organizației. Se resetează odată cu perioada de facturare; un administrator al organizației poate mări limita unui membru.
403ai_consent_withdrawn: Proprietarul cheii sau al documentului și-a retras consimțământul pentru prelucrarea cu IA. Îl poate acorda din nou în setările de confidențialitate.
403forbidden: Cheia poate citi resursa, dar nu o poate modifica, sau acțiunea nu este permisă pentru ea. Cereți proprietarului acces de editare.
403insufficient_scope: Cheii îi lipsește o permisiune necesară acestei operațiuni; mesajul o numește. Creați o cheie cu acea permisiune.
403ip_not_allowed: Cheia are o listă de IP-uri permise, iar cererea a venit de la o adresă din afara ei. Apelați de la o adresă permisă sau modificați lista din Setări › Dezvoltatori.
403plan_required: Planul proprietarului cheii nu include acces la API sau proprietarul a părăsit organizația. Accesul la API necesită Pro sau Enterprise.
404not_found: Resursa nu există sau această cheie nu o poate vedea. Verificați id-ul și dacă proprietarul cheii are acces.
405method_not_allowed: Calea nu acceptă această metodă HTTP. Antetul Allow listează metodele acceptate.
409conflict: Cererea intră în conflict cu starea curentă a resursei, de exemplu o acțiune deja efectuată. Citiți resursa și decideți din nou.
409idempotency_request_in_progress: O cerere cu aceeași Idempotency-Key încă rulează. Interogați adresa din antetul Location sau încercați din nou după Retry-After secunde.
413payload_too_large: Corpul sau fișierul încărcat este prea mare. Fișierele pot avea până la 10 MB.
415unsupported_media_type: Corpul are un format pe care această operațiune nu îl acceptă. Trimiteți JSON sau multipart/form-data acolo unde încărcarea este permisă.
422idempotency_key_reused: Această Idempotency-Key a fost folosită deja pentru altă cerere. Folosiți o cheie nouă pentru fiecare cerere diferită.
422unprocessable: Cererea este validă, dar nu poate fi executată, de exemplu analiza unui document fără lege aplicabilă aleasă. Mesajul spune ce lipsește.
429concurrency_limit_exceeded: Organizația dumneavoastră rulează deja simultan câte operații AI de lungă durată îi sunt permise. Așteptați să se termine una sau secundele din Retry-After, apoi reîncercați.
429rate_limited: Prea multe cereri într-una dintre ferestrele în care contează această cheie. Așteptați numărul de secunde din Retry-After, apoi reîncercați. Antetul RateLimit arată ce fereastră este plină.
500internal_error: Ceva nu a mers bine la Attorly. Încercați din nou cu aceeași Idempotency-Key; dacă problema persistă, contactați asistența cu requestId.
504timeout: Operațiunea nu s-a încheiat la timp. Încercați din nou cu aceeași Idempotency-Key sau trimiteți Prefer: respond-async și interogați operațiunea.