Dokumentácia REST API
REST API
Chybové kódy
Všetky chybové kódy, ktoré API vracia, so stavom HTTP, významom a postupom, čo robiť.
Tvar chyby
Chyby sú JSON v tomto tvare. Riaďte sa poľom code, ktoré sa nikdy nemení; message je pre ľudí a môže sa zmeniť. details pri 400 vypisuje každé neplatné pole.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kódy
Na kód odkazujte priamo pomocou jeho názvu ako kotvy, napríklad /docs/api/errors#rate_limited.
- 400invalid_request
- Telo, dopyt alebo hlavička sú neplatné. details uvádza každé problematické pole. Opravte požiadavku; bez zmeny opäť zlyhá.
- 401api_key_expired
- Platnosť kľúča vypršala. Vytvorte nový kľúč, alebo ho vymeňte a získajte nové tajomstvo.
- 401api_key_revoked
- Kľúč bol zneplatnený. Vytvorte nový kľúč v Nastavenia › Vývojári.
- 401invalid_api_key
- Žiadny kľúč nezodpovedá. Skontrolujte, či ste skopírovali celý kľúč, alebo vytvorte nový v Nastavenia › Vývojári.
- 402insufficient_credits
- Kredity AI vlastníka kľúča sa minuli. Dobite ich alebo zmeňte plán v Attorly a skúste to znova.
- 402usage_limit_exceeded
- Dosiahol sa limit využitia AI vlastníka kľúča alebo organizácie. Obnoví sa s fakturačným obdobím; správca organizácie môže limit člena zvýšiť.
- 403ai_consent_withdrawn
- Vlastník kľúča alebo dokumentu odvolal súhlas so spracovaním pomocou AI. Súhlas možno znova udeliť v nastaveniach súkromia.
- 403forbidden
- Kľúč smie zdroj čítať, ale nie meniť, alebo akcia nie je pre zdroj povolená. Požiadajte vlastníka o oprávnenie na úpravy.
- 403insufficient_scope
- Kľúču chýba oprávnenie, ktoré táto operácia potrebuje; správa ho uvádza. Vytvorte kľúč s týmto oprávnením.
- 403ip_not_allowed
- Kľúč má zoznam povolených IP adries a požiadavka prišla z adresy mimo neho. Volajte z povolenej adresy alebo zoznam zmeňte v Nastavenia › Vývojári.
- 403plan_required
- Plán vlastníka kľúča nezahŕňa prístup k API, alebo vlastník opustil organizáciu. Prístup k API vyžaduje Pro alebo Enterprise.
- 404not_found
- Zdroj neexistuje, alebo ho tento kľúč nevidí. Skontrolujte identifikátor a to, či má vlastník kľúča prístup.
- 405method_not_allowed
- Cesta nepodporuje túto metódu HTTP. Hlavička Allow uvádza podporované metódy.
- 409conflict
- Požiadavka je v rozpore s aktuálnym stavom zdroja, napríklad akcia už bola vykonaná. Načítajte zdroj a rozhodnite znova.
- 409idempotency_request_in_progress
- Požiadavka s rovnakým Idempotency-Key ešte beží. Dopytujte sa na adresu z hlavičky Location, alebo to skúste znova po Retry-After sekundách.
- 413payload_too_large
- Telo alebo nahraný súbor je príliš veľký. Súbory môžu mať najviac 10 MB.
- 415unsupported_media_type
- Telo je vo formáte, ktorý táto operácia neprijíma. Pošlite JSON, alebo multipart/form-data tam, kde je nahrávanie povolené.
- 422idempotency_key_reused
- Tento Idempotency-Key už bol použitý pre inú požiadavku. Pre každú odlišnú požiadavku použite nový kľúč.
- 422unprocessable
- Požiadavka je platná, ale nemožno ju vykonať, napríklad analýzu dokumentu bez zvoleného rozhodného práva. Správa uvádza, čo chýba.
- 429concurrency_limit_exceeded
- Vaša organizácia už súčasne spúšťa toľko dlhých operácií AI, koľko smie. Počkajte, kým jedna skončí, alebo počet sekúnd z Retry-After, a skúste to znova.
- 429rate_limited
- Príliš veľa požiadaviek v jednom z okien, do ktorých sa tento kľúč počíta. Počkajte počet sekúnd z Retry-After a skúste to znova. Hlavička RateLimit ukazuje, ktoré okno je plné.
- 500internal_error
- V Attorly sa niečo pokazilo. Skúste to znova s rovnakým Idempotency-Key; ak problém pretrváva, kontaktujte podporu a uveďte requestId.
- 504timeout
- Operácia sa nedokončila včas. Skúste to znova s rovnakým Idempotency-Key, alebo pošlite Prefer: respond-async a dopytujte sa na operáciu.