REST API dokumentatsioon
REST API
Veakoodid
Kõik API tagastatavad veakoodid koos HTTP-oleku, tähenduse ja tegevusjuhisega.
Vea kuju
Vead on sellise kujuga JSON. Rajage loogika väljale code, mis kunagi ei muutu; message on inimestele ja võib muutuda. details loetleb koodi 400 korral iga vigase välja.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Koodid
Viidake koodile otse, kasutades selle nime ankruna, näiteks /docs/api/errors#rate_limited.
- 400invalid_request
- Sisu, päring või päis on vigane. details nimetab iga probleemse välja. Parandage päring; muutmata kujul ebaõnnestub see uuesti.
- 401api_key_expired
- Võti on aegunud. Looge uus võti või vahetage see, et saada uus saladus.
- 401api_key_revoked
- Võti on tühistatud. Looge uus võti jaotises Seaded › Arendajad.
- 401invalid_api_key
- Ükski võti ei sobi. Kontrollige, kas kogu võti kopeeriti, või looge uus jaotises Seaded › Arendajad.
- 402insufficient_credits
- Võtme omaniku tehisintellekti krediidid on otsas. Laadige juurde või vahetage Attorlys paketti ja proovige uuesti.
- 402usage_limit_exceeded
- Võtme omaniku või organisatsiooni tehisintellekti kasutuspiirang on täis. See lähtestub arveldusperioodiga; organisatsiooni administraator saab liikme piirangut tõsta.
- 403ai_consent_withdrawn
- Võtme või dokumendi omanik on tehisintellektiga töötlemise nõusoleku tagasi võtnud. Selle saab uuesti anda privaatsusseadetes.
- 403forbidden
- Võti tohib ressurssi lugeda, kuid mitte muuta, või toiming pole selle jaoks lubatud. Küsige omanikult muutmisõigust.
- 403insufficient_scope
- Võtmel puudub õigus, mida see toiming vajab; sõnum nimetab selle. Looge selle õigusega võti.
- 403ip_not_allowed
- Võtmel on lubatud IP-aadresside loend ja päring tuli väljaspool seda olevalt aadressilt. Kutsuge lubatud aadressilt või muutke loendit jaotises Seaded › Arendajad.
- 403plan_required
- Võtme omaniku pakett ei sisalda API-juurdepääsu või omanik on organisatsioonist lahkunud. API-juurdepääs nõuab paketti Pro või Enterprise.
- 404not_found
- Ressurssi pole olemas või see võti ei näe seda. Kontrollige ID-d ja seda, kas võtme omanikul on juurdepääs.
- 405method_not_allowed
- Tee ei toeta seda HTTP-meetodit. Allow päis loetleb toetatud meetodid.
- 409conflict
- Päring on vastuolus ressursi praeguse olekuga, näiteks juba tehtud toiming. Lugege ressurss ja otsustage uuesti.
- 409idempotency_request_in_progress
- Sama Idempotency-Key'ga päring on veel pooleli. Pärige Location päises olevat aadressi või proovige uuesti Retry-After sekundi pärast.
- 413payload_too_large
- Sisu või üleslaaditud fail on liiga suur. Failid võivad olla kuni 10 MB.
- 415unsupported_media_type
- Sisu on vormingus, mida see toiming ei aktsepteeri. Saatke JSON või multipart/form-data, kus üleslaadimine on lubatud.
- 422idempotency_key_reused
- Seda Idempotency-Key'd on juba kasutatud teise päringu jaoks. Kasutage iga erineva päringu jaoks uut võtit.
- 422unprocessable
- Päring on kehtiv, kuid seda ei saa täita, näiteks dokumendi analüüs, millele pole kohaldatavat õigust valitud. Sõnum ütleb, mis puudub.
- 429concurrency_limit_exceeded
- Teie organisatsioon käitab juba nii palju pikki AI-toiminguid korraga, kui tohib. Oodake, kuni üks lõpeb, või Retry-Afteri sekundid, ja proovige uuesti.
- 429rate_limited
- Liiga palju päringuid ühes aknas, kuhu see võti loetakse. Oodake Retry-Afteris märgitud sekundid ja proovige uuesti. RateLimit-päis näitab, milline aken on täis.
- 500internal_error
- Attorlys läks midagi valesti. Proovige uuesti sama Idempotency-Key'ga; kui probleem püsib, võtke ühendust toega ja märkige requestId.
- 504timeout
- Toiming ei lõppenud õigel ajal. Proovige uuesti sama Idempotency-Key'ga või saatke Prefer: respond-async ja pärige toimingut.