Dokumentacija REST API
REST API
Kode napak
Vse kode napak, ki jih vrača API, s stanjem HTTP, pomenom in navodili, kaj storiti.
Oblika napake
Napake so JSON v tej obliki. Logiko gradite na polju code, ki se nikoli ne spremeni; message je za ljudi in se lahko spremeni. details pri 400 izpiše vsako neveljavno polje.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kode
Na kodo povežite neposredno z njenim imenom kot sidrom, na primer /docs/api/errors#rate_limited.
- 400invalid_request
- Telo, poizvedba ali glava ni veljavna. details navede vsako težavno polje. Popravite zahtevo; nespremenjena ne bo znova uspela.
- 401api_key_expired
- Ključ je potekel. Ustvarite nov ključ ali ga zamenjajte, da dobite novo skrivnost.
- 401api_key_revoked
- Ključ je bil preklican. Ustvarite nov ključ v Nastavitve › Razvijalci.
- 401invalid_api_key
- Noben ključ se ne ujema. Preverite, ali ste kopirali celoten ključ, ali pa ustvarite novega v Nastavitve › Razvijalci.
- 402insufficient_credits
- Krediti UI lastnika ključa so porabljeni. Napolnite jih ali zamenjajte paket v Attorly in poskusite znova.
- 402usage_limit_exceeded
- Dosežena je omejitev porabe UI lastnika ključa ali organizacije. Ponastavi se z obračunskim obdobjem; skrbnik organizacije lahko omejitev člana zviša.
- 403ai_consent_withdrawn
- Lastnik ključa ali dokumenta je preklical privolitev v obdelavo z UI. Ponovno jo lahko da v nastavitvah zasebnosti.
- 403forbidden
- Ključ sme vir brati, ne pa ga spreminjati, ali pa dejanje zanj ni dovoljeno. Lastnika prosite za dostop za urejanje.
- 403insufficient_scope
- Ključu manjka pravica, ki jo ta operacija potrebuje; sporočilo jo navede. Ustvarite ključ s to pravico.
- 403ip_not_allowed
- Ključ ima seznam dovoljenih naslovov IP, zahteva pa je prišla z naslova zunaj njega. Kličite z dovoljenega naslova ali spremenite seznam v Nastavitve › Razvijalci.
- 403plan_required
- Paket lastnika ključa ne vključuje dostopa do API-ja ali pa je lastnik zapustil organizacijo. Dostop do API-ja zahteva Pro ali Enterprise.
- 404not_found
- Vir ne obstaja ali pa ga ta ključ ne vidi. Preverite identifikator in ali ima lastnik ključa dostop.
- 405method_not_allowed
- Pot ne podpira te metode HTTP. Glava Allow navaja podprte metode.
- 409conflict
- Zahteva je v nasprotju s trenutnim stanjem vira, na primer dejanje je že opravljeno. Preberite vir in se znova odločite.
- 409idempotency_request_in_progress
- Zahteva z istim Idempotency-Key še teče. Poizvedujte naslov iz glave Location ali poskusite znova po Retry-After sekundah.
- 413payload_too_large
- Telo ali naložena datoteka je prevelika. Datoteke so lahko velike do 10 MB.
- 415unsupported_media_type
- Telo je v obliki, ki je ta operacija ne sprejema. Pošljite JSON ali multipart/form-data, kjer je nalaganje dovoljeno.
- 422idempotency_key_reused
- Ta Idempotency-Key je bil že uporabljen za drugo zahtevo. Za vsako drugačno zahtevo uporabite nov ključ.
- 422unprocessable
- Zahteva je veljavna, vendar je ni mogoče izvesti, na primer analiza dokumenta brez izbranega veljavnega prava. Sporočilo pove, kaj manjka.
- 429concurrency_limit_exceeded
- Vaša organizacija že hkrati izvaja toliko dolgotrajnih operacij UI, kot sme. Počakajte, da se ena konča, ali toliko sekund, kot je navedeno v Retry-After, in poskusite znova.
- 429rate_limited
- Preveč zahtev v enem od oken, v katera se šteje ta ključ. Počakajte toliko sekund, kot je navedeno v Retry-After, in poskusite znova. Glava RateLimit pokaže, katero okno je polno.
- 500internal_error
- V Attorly je šlo nekaj narobe. Poskusite znova z istim Idempotency-Key; če težava ostane, se obrnite na podporo in navedite requestId.
- 504timeout
- Operacija se ni pravočasno končala. Poskusite znova z istim Idempotency-Key ali pošljite Prefer: respond-async in poizvedujte operacijo.