Dokumentacija REST API-ja
REST API
Kodovi pogrešaka
Svi kodovi pogrešaka koje API vraća, s HTTP statusom, značenjem i uputama što učiniti.
Oblik pogreške
Pogreške su JSON ovog oblika. Logiku temeljite na polju code, koje se nikad ne mijenja; message je za ljude i može se promijeniti. details kod 400 ispisuje svako nevaljano polje.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kodovi
Na kod se povežite izravno koristeći njegov naziv kao sidro, na primjer /docs/api/errors#rate_limited.
- 400invalid_request
- Tijelo, upit ili zaglavlje nije valjano. details navodi svako problematično polje. Ispravite zahtjev; nepromijenjen će ponovno ne uspjeti.
- 401api_key_expired
- Ključ je istekao. Stvorite novi ključ ili ga zamijenite da dobijete novu tajnu.
- 401api_key_revoked
- Ključ je opozvan. Stvorite novi ključ u Postavke › Razvojni programeri.
- 401invalid_api_key
- Nijedan ključ se ne podudara. Provjerite je li kopiran cijeli ključ ili stvorite novi u Postavke › Razvojni programeri.
- 402insufficient_credits
- AI krediti vlasnika ključa su potrošeni. Nadoplatite ili promijenite paket u Attorlyju i pokušajte ponovno.
- 402usage_limit_exceeded
- Dosegnuto je ograničenje AI potrošnje vlasnika ključa ili organizacije. Resetira se s obračunskim razdobljem; administrator organizacije može povećati ograničenje člana.
- 403ai_consent_withdrawn
- Vlasnik ključa ili dokumenta povukao je privolu za AI obradu. Može je ponovno dati u postavkama privatnosti.
- 403forbidden
- Ključ smije čitati resurs, ali ne i mijenjati ga, ili radnja za njega nije dopuštena. Zatražite od vlasnika pristup za uređivanje.
- 403insufficient_scope
- Ključu nedostaje ovlast koja treba ovoj operaciji; poruka je navodi. Stvorite ključ s tom ovlasti.
- 403ip_not_allowed
- Ključ ima popis dopuštenih IP adresa, a zahtjev je stigao s adrese izvan njega. Pozovite s dopuštene adrese ili promijenite popis u Postavke › Razvojni programeri.
- 403plan_required
- Paket vlasnika ključa ne uključuje pristup API-ju ili je vlasnik napustio organizaciju. Pristup API-ju zahtijeva Pro ili Enterprise.
- 404not_found
- Resurs ne postoji ili ga ovaj ključ ne vidi. Provjerite identifikator i ima li vlasnik ključa pristup.
- 405method_not_allowed
- Putanja ne podržava ovu HTTP metodu. Zaglavlje Allow navodi podržane metode.
- 409conflict
- Zahtjev je u sukobu s trenutnim stanjem resursa, na primjer radnja je već izvršena. Pročitajte resurs i odlučite ponovno.
- 409idempotency_request_in_progress
- Zahtjev s istim Idempotency-Key još traje. Ispitujte adresu iz zaglavlja Location ili pokušajte ponovno nakon Retry-After sekundi.
- 413payload_too_large
- Tijelo ili učitana datoteka je prevelika. Datoteke mogu imati do 10 MB.
- 415unsupported_media_type
- Tijelo je u formatu koji ova operacija ne prima. Pošaljite JSON ili multipart/form-data gdje je učitavanje dopušteno.
- 422idempotency_key_reused
- Ovaj Idempotency-Key već je korišten za drugi zahtjev. Za svaki drugačiji zahtjev koristite novi ključ.
- 422unprocessable
- Zahtjev je valjan, ali se ne može izvršiti, na primjer analiza dokumenta bez odabranog mjerodavnog prava. Poruka kaže što nedostaje.
- 429concurrency_limit_exceeded
- Vaša organizacija već istodobno izvodi onoliko dugotrajnih AI operacija koliko smije. Pričekajte da jedna završi ili broj sekundi iz Retry-After i pokušajte ponovno.
- 429rate_limited
- Previše zahtjeva u jednom od prozora u koje se broji ovaj ključ. Pričekajte broj sekundi iz Retry-After i pokušajte ponovno. Zaglavlje RateLimit pokazuje koji je prozor pun.
- 500internal_error
- Nešto je pošlo po zlu u Attorlyju. Pokušajte ponovno s istim Idempotency-Key; ako se nastavi, obratite se podršci i navedite requestId.
- 504timeout
- Operacija nije dovršena na vrijeme. Pokušajte ponovno s istim Idempotency-Key ili pošaljite Prefer: respond-async i ispitujte operaciju.