REST API

Chybové kódy

Name: Attorly AI
Availability: InStock

Všechny chybové kódy, které API vrací, se stavem HTTP, významem a postupem, co dělat.

Tvar chyby

Chyby jsou JSON v tomto tvaru. Řiďte se polem code, které se nikdy nemění; message je pro lidi a může se změnit. details u 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 přímo pomocí jeho názvu jako kotvy, například /docs/api/errors#rate_limited.

400invalid_request: Tělo, dotaz nebo hlavička jsou neplatné. details uvádí každé problematické pole. Opravte požadavek; beze změny opět selže.
401api_key_expired: Platnost klíče vypršela. Vytvořte nový klíč, nebo ho vyměňte a získejte nové tajemství.
401api_key_revoked: Klíč byl zneplatněn. Vytvořte nový klíč v Nastavení › Vývojáři.
401invalid_api_key: Žádný klíč neodpovídá. Zkontrolujte, že jste zkopírovali celý klíč, nebo vytvořte nový v Nastavení › Vývojáři.
401unauthorized: Hlavička Authorization chybí, nebo neobsahuje slovo Bearer a za ním klíč. Posílejte klíč jako token Bearer.
402insufficient_credits: Kredity AI vlastníka klíče došly. Dobijte je nebo změňte plán v Attorly a zkuste to znovu.
402usage_limit_exceeded: Byl dosažen limit využití AI vlastníka klíče nebo organizace. Obnoví se s fakturačním obdobím; správce organizace může limit člena zvýšit.
403ai_consent_withdrawn: Vlastník klíče nebo dokumentu odvolal souhlas se zpracováním pomocí AI. Souhlas lze znovu udělit v nastavení soukromí.
403forbidden: Klíč smí zdroj číst, ale ne měnit, nebo akce není pro zdroj povolena. Požádejte vlastníka o oprávnění k úpravám.
403insufficient_scope: Klíči chybí oprávnění, které tato operace potřebuje; zpráva ho uvádí. Vytvořte klíč s tímto oprávněním.
403ip_not_allowed: Klíč má seznam povolených IP adres a požadavek přišel z adresy mimo něj. Volejte z povolené adresy, nebo seznam změňte v Nastavení › Vývojáři.
403plan_required: Plán vlastníka klíče nezahrnuje přístup k API, nebo vlastník opustil organizaci. Přístup k API vyžaduje Pro nebo Enterprise.
404not_found: Zdroj neexistuje, nebo ho tento klíč nevidí. Zkontrolujte identifikátor a to, zda má vlastník klíče přístup.
405method_not_allowed: Cesta nepodporuje tuto metodu HTTP. Hlavička Allow uvádí podporované metody.
409conflict: Požadavek je v rozporu s aktuálním stavem zdroje, například akce už byla provedena. Načtěte zdroj a rozhodněte znovu.
409idempotency_request_in_progress: Požadavek se stejným Idempotency-Key stále běží. Dotazujte se na adresu z hlavičky Location, nebo to zkuste znovu po Retry-After sekundách.
413payload_too_large: Tělo nebo nahraný soubor je příliš velký. Soubory mohou mít až 10 MB.
415unsupported_media_type: Tělo je ve formátu, který tato operace nepřijímá. Pošlete JSON, nebo multipart/form-data tam, kde je nahrávání povoleno.
422idempotency_key_reused: Tento Idempotency-Key už byl použit pro jiný požadavek. Pro každý odlišný požadavek použijte nový klíč.
422unprocessable: Požadavek je platný, ale nelze ho provést, například analýzu dokumentu bez zvoleného rozhodného práva. Zpráva uvádí, co chybí.
429concurrency_limit_exceeded: Vaše organizace už současně spouští tolik dlouhých operací AI, kolik smí. Počkejte, až jedna skončí, nebo počet sekund z Retry-After, a zkuste to znovu.
429rate_limited: Příliš mnoho požadavků v jednom z oken, do kterých se tento klíč počítá. Počkejte počet sekund z Retry-After a zkuste to znovu. Hlavička RateLimit ukazuje, které okno je plné.
500internal_error: V Attorly se něco pokazilo. Zkuste to znovu se stejným Idempotency-Key; pokud potíže trvají, kontaktujte podporu a uveďte requestId.
504timeout: Operace nebyla včas dokončena. Zkuste to znovu se stejným Idempotency-Key, nebo pošlete Prefer: respond-async a dotazujte se na operaci.