REST API dokumentacija
REST API
Klaidų kodai
Visi API grąžinami klaidų kodai su HTTP būsena, reikšme ir nurodymais, ką daryti.
Klaidos forma
Klaidos yra tokios formos JSON. Logiką grįskite lauku code, kuris niekada nesikeičia; message skirtas žmonėms ir gali keistis. details esant 400 išvardija kiekvieną netinkamą lauką.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kodai
Nuorodą į kodą darykite tiesiogiai, naudodami jo pavadinimą kaip inkarą, pavyzdžiui, /docs/api/errors#rate_limited.
- 400invalid_request
- Turinys, užklausa arba antraštė netinkami. details nurodo kiekvieną probleminį lauką. Pataisykite užklausą; nepakeista ji vėl nepavyks.
- 401api_key_expired
- Rakto galiojimas baigėsi. Sukurkite naują raktą arba pakeiskite jį, kad gautumėte naują paslaptį.
- 401api_key_revoked
- Raktas atšauktas. Sukurkite naują raktą skiltyje Nustatymai › Kūrėjams.
- 401invalid_api_key
- Joks raktas neatitinka. Patikrinkite, ar nukopijuotas visas raktas, arba sukurkite naują skiltyje Nustatymai › Kūrėjams.
- 402insufficient_credits
- Rakto savininko DI kreditai baigėsi. Papildykite arba pakeiskite planą Attorly ir bandykite dar kartą.
- 402usage_limit_exceeded
- Pasiektas rakto savininko arba organizacijos DI naudojimo apribojimas. Jis atstatomas su atsiskaitymo laikotarpiu; organizacijos administratorius gali padidinti nario apribojimą.
- 403ai_consent_withdrawn
- Rakto arba dokumento savininkas atšaukė sutikimą tvarkyti duomenis DI. Jį galima vėl duoti privatumo nustatymuose.
- 403forbidden
- Raktas gali skaityti išteklių, bet negali jo keisti, arba veiksmas jam neleidžiamas. Paprašykite savininko redagavimo teisės.
- 403insufficient_scope
- Raktui trūksta teisės, kurios reikia šiai operacijai; pranešime ji nurodyta. Sukurkite raktą su ta teise.
- 403ip_not_allowed
- Raktas turi leidžiamų IP adresų sąrašą, o užklausa atėjo iš adreso už jo ribų. Kvieskite iš leidžiamo adreso arba pakeiskite sąrašą skiltyje Nustatymai › Kūrėjams.
- 403plan_required
- Rakto savininko planas neapima prieigos prie API arba savininkas paliko organizaciją. Prieigai prie API reikia Pro arba Enterprise.
- 404not_found
- Ištekliaus nėra arba šis raktas jo nemato. Patikrinkite ID ir ar rakto savininkas turi prieigą.
- 405method_not_allowed
- Kelias nepalaiko šio HTTP metodo. Allow antraštė išvardija palaikomus metodus.
- 409conflict
- Užklausa prieštarauja dabartinei ištekliaus būsenai, pavyzdžiui, veiksmas jau atliktas. Perskaitykite išteklių ir nuspręskite iš naujo.
- 409idempotency_request_in_progress
- Užklausa su tuo pačiu Idempotency-Key dar vykdoma. Tikrinkite Location antraštės adresą arba bandykite dar kartą po Retry-After sekundžių.
- 413payload_too_large
- Turinys arba įkeltas failas per didelis. Failai gali būti iki 10 MB.
- 415unsupported_media_type
- Turinys yra formatu, kurio ši operacija nepriima. Siųskite JSON arba multipart/form-data, kur leidžiama įkelti.
- 422idempotency_key_reused
- Šis Idempotency-Key jau buvo naudotas kitai užklausai. Kiekvienai skirtingai užklausai naudokite naują raktą.
- 422unprocessable
- Užklausa tinkama, bet jos negalima įvykdyti, pavyzdžiui, dokumento analizė be pasirinktos taikytinos teisės. Pranešime nurodyta, ko trūksta.
- 429concurrency_limit_exceeded
- Jūsų organizacija jau vienu metu vykdo tiek ilgos trukmės DI operacijų, kiek leidžiama. Palaukite, kol viena baigsis, arba Retry-After sekundžių, ir bandykite dar kartą.
- 429rate_limited
- Per daug užklausų viename iš langų, kuriuose skaičiuojamas šis raktas. Palaukite Retry-After nurodytas sekundes ir bandykite dar kartą. Antraštė RateLimit rodo, kuris langas pilnas.
- 500internal_error
- Attorly įvyko klaida. Bandykite dar kartą su tuo pačiu Idempotency-Key; jei klaida kartojasi, kreipkitės į pagalbos tarnybą nurodydami requestId.
- 504timeout
- Operacija nebuvo baigta laiku. Bandykite dar kartą su tuo pačiu Idempotency-Key arba siųskite Prefer: respond-async ir tikrinkite operaciją.