REST API dokumentācija
REST API
Kļūdu kodi
Visi API atgrieztie kļūdu kodi ar HTTP statusu, nozīmi un norādēm, kas jādara.
Kļūdas forma
Kļūdas ir šādas formas JSON. Veidojiet loģiku uz lauka code, kas nekad nemainās; message ir paredzēts cilvēkiem un var mainīties. details pie 400 uzskaita katru nederīgo lauku.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kodi
Norādiet uz kodu tieši, izmantojot tā nosaukumu kā enkuru, piemēram, /docs/api/errors#rate_limited.
- 400invalid_request
- Saturs, vaicājums vai galvene nav derīga. details nosauc katru problemātisko lauku. Izlabojiet pieprasījumu; nemainīts tas atkal neizdosies.
- 401api_key_expired
- Atslēgas derīgums ir beidzies. Izveidojiet jaunu atslēgu vai nomainiet to, lai saņemtu jaunu noslēpumu.
- 401api_key_revoked
- Atslēga ir atsaukta. Izveidojiet jaunu atslēgu sadaļā Iestatījumi › Izstrādātājiem.
- 401invalid_api_key
- Neviena atslēga neatbilst. Pārbaudiet, vai nokopēta visa atslēga, vai izveidojiet jaunu sadaļā Iestatījumi › Izstrādātājiem.
- 402insufficient_credits
- Atslēgas īpašnieka MI kredīti ir izsmelti. Papildiniet vai mainiet plānu Attorly un mēģiniet vēlreiz.
- 402usage_limit_exceeded
- Sasniegts atslēgas īpašnieka vai organizācijas MI lietojuma ierobežojums. Tas tiek atiestatīts līdz ar norēķinu periodu; organizācijas administrators var palielināt dalībnieka ierobežojumu.
- 403ai_consent_withdrawn
- Atslēgas vai dokumenta īpašnieks ir atsaucis piekrišanu apstrādei ar MI. To var dot atkārtoti privātuma iestatījumos.
- 403forbidden
- Atslēga drīkst lasīt resursu, bet ne mainīt to, vai darbība tai nav atļauta. Palūdziet īpašniekam rediģēšanas tiesības.
- 403insufficient_scope
- Atslēgai trūkst tiesības, kas vajadzīga šai darbībai; ziņojumā tā nosaukta. Izveidojiet atslēgu ar šo tiesību.
- 403ip_not_allowed
- Atslēgai ir atļauto IP adrešu saraksts, un pieprasījums nāca no adreses ārpus tā. Izsauciet no atļautas adreses vai mainiet sarakstu sadaļā Iestatījumi › Izstrādātājiem.
- 403plan_required
- Atslēgas īpašnieka plāns neietver piekļuvi API vai īpašnieks ir pametis organizāciju. Piekļuvei API vajadzīgs Pro vai Enterprise.
- 404not_found
- Resurss neeksistē vai šī atslēga to neredz. Pārbaudiet ID un to, vai atslēgas īpašniekam ir piekļuve.
- 405method_not_allowed
- Ceļš neatbalsta šo HTTP metodi. Allow galvene uzskaita atbalstītās metodes.
- 409conflict
- Pieprasījums ir pretrunā ar resursa pašreizējo stāvokli, piemēram, darbība jau ir veikta. Nolasiet resursu un izlemiet vēlreiz.
- 409idempotency_request_in_progress
- Pieprasījums ar to pašu Idempotency-Key joprojām tiek izpildīts. Pārbaudiet Location galvenes adresi vai mēģiniet vēlreiz pēc Retry-After sekundēm.
- 413payload_too_large
- Saturs vai augšupielādētais fails ir pārāk liels. Faili var būt līdz 10 MB.
- 415unsupported_media_type
- Saturs ir formātā, ko šī darbība nepieņem. Sūtiet JSON vai multipart/form-data, kur augšupielāde ir atļauta.
- 422idempotency_key_reused
- Šis Idempotency-Key jau izmantots citam pieprasījumam. Katram atšķirīgam pieprasījumam izmantojiet jaunu atslēgu.
- 422unprocessable
- Pieprasījums ir derīgs, bet to nevar izpildīt, piemēram, dokumenta analīze bez izvēlētiem piemērojamiem tiesību aktiem. Ziņojumā norādīts, kas trūkst.
- 429concurrency_limit_exceeded
- Jūsu organizācija jau vienlaikus izpilda tik daudz ilgu AI operāciju, cik drīkst. Pagaidiet, līdz kāda beidzas, vai Retry-After sekundes, un mēģiniet vēlreiz.
- 429rate_limited
- Pārāk daudz pieprasījumu kādā no logiem, kuros tiek skaitīta šī atslēga. Pagaidiet Retry-After norādītās sekundes un mēģiniet vēlreiz. Galvene RateLimit rāda, kurš logs ir pilns.
- 500internal_error
- Attorly radās kļūda. Mēģiniet vēlreiz ar to pašu Idempotency-Key; ja tā atkārtojas, sazinieties ar atbalsta dienestu un norādiet requestId.
- 504timeout
- Darbība netika pabeigta laikā. Mēģiniet vēlreiz ar to pašu Idempotency-Key vai sūtiet Prefer: respond-async un pārbaudiet darbību.