REST API-dokumentáció
REST API
Hibakódok
Az API által visszaadott összes hibakód HTTP-állapottal, jelentéssel és teendővel.
A hiba formája
A hibák ilyen formájú JSON-ok. A logikát a soha nem változó code mezőre építse; a message embereknek szól, és változhat. A details 400 esetén minden érvénytelen mezőt felsorol.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kódok
Egy kódra közvetlenül hivatkozhat a nevével mint horgonnyal, például /docs/api/errors#rate_limited.
- 400invalid_request
- A törzs, a lekérdezés vagy egy fejléc érvénytelen. A details minden hibás mezőt megnevez. Javítsa a kérést; változatlanul újra sikertelen lesz.
- 401api_key_expired
- A kulcs lejárt. Hozzon létre új kulcsot, vagy cserélje le, hogy új titkot kapjon.
- 401api_key_revoked
- A kulcsot visszavonták. Hozzon létre új kulcsot a Beállítások › Fejlesztők oldalon.
- 401invalid_api_key
- Egyik kulcs sem egyezik. Ellenőrizze, hogy a teljes kulcsot másolta-e ki, vagy hozzon létre újat a Beállítások › Fejlesztők oldalon.
- 402insufficient_credits
- A kulcs tulajdonosának MI-kreditjei elfogytak. Töltse fel vagy váltson csomagot az Attorlyban, majd próbálja újra.
- 402usage_limit_exceeded
- Elérte a kulcs tulajdonosának vagy a szervezetnek az MI-használati korlátját. A számlázási időszakkal nullázódik; a szervezet adminisztrátora megemelheti egy tag korlátját.
- 403ai_consent_withdrawn
- A kulcs vagy a dokumentum tulajdonosa visszavonta az MI-feldolgozáshoz adott hozzájárulását. Az adatvédelmi beállításokban újra megadható.
- 403forbidden
- A kulcs olvashatja az erőforrást, de nem módosíthatja, vagy a művelet nem engedélyezett rá. Kérjen szerkesztési jogot a tulajdonostól.
- 403insufficient_scope
- A kulcsból hiányzik egy jogosultság, amely ehhez a művelethez kell; az üzenet megnevezi. Hozzon létre kulcsot ezzel a jogosultsággal.
- 403ip_not_allowed
- A kulcsnak IP-engedélyezési listája van, és a kérés a listán kívüli címről érkezett. Hívja engedélyezett címről, vagy módosítsa a listát a Beállítások › Fejlesztők menüben.
- 403plan_required
- A kulcs tulajdonosának csomagja nem tartalmaz API-hozzáférést, vagy a tulajdonos kilépett a szervezetből. Az API-hozzáféréshez Pro vagy Enterprise csomag kell.
- 404not_found
- Az erőforrás nem létezik, vagy ez a kulcs nem látja. Ellenőrizze az azonosítót, és hogy a kulcs tulajdonosának van-e hozzáférése.
- 405method_not_allowed
- Az útvonal nem támogatja ezt a HTTP-metódust. Az Allow fejléc felsorolja a támogatott metódusokat.
- 409conflict
- A kérés ütközik az erőforrás jelenlegi állapotával, például egy már elvégzett művelet. Olvassa be az erőforrást, és döntsön újra.
- 409idempotency_request_in_progress
- Egy azonos Idempotency-Key kulcsú kérés még fut. Kérdezze le a Location fejlécben lévő címet, vagy próbálja újra a Retry-After másodperc után.
- 413payload_too_large
- A törzs vagy a feltöltött fájl túl nagy. A fájlok legfeljebb 10 MB-osak lehetnek.
- 415unsupported_media_type
- A törzs olyan formátumú, amelyet ez a művelet nem fogad. Küldjön JSON-t, vagy multipart/form-data adatot, ahol a feltöltés engedélyezett.
- 422idempotency_key_reused
- Ezt az Idempotency-Key kulcsot már egy másik kéréshez használták. Minden eltérő kéréshez új kulcsot használjon.
- 422unprocessable
- A kérés érvényes, de nem hajtható végre, például egy olyan dokumentum elemzése, amelyhez nincs kiválasztva irányadó jog. Az üzenet megmondja, mi hiányzik.
- 429concurrency_limit_exceeded
- A szervezete már annyi hosszan futó AI-műveletet futtat egyszerre, amennyit lehet. Várja meg, amíg az egyik befejeződik, vagy a Retry-After másodperceit, majd próbálja újra.
- 429rate_limited
- Túl sok kérés az egyik ablakban, amelybe ez a kulcs beleszámít. Várjon a Retry-After-ben megadott másodpercig, majd próbálja újra. A RateLimit fejléc mutatja, melyik ablak telt meg.
- 500internal_error
- Hiba történt az Attorlynál. Próbálja újra ugyanazzal az Idempotency-Key kulccsal; ha a hiba megmarad, forduljon a támogatáshoz a requestId megadásával.
- 504timeout
- A művelet nem fejeződött be időben. Próbálja újra ugyanazzal az Idempotency-Key kulccsal, vagy küldjön Prefer: respond-async fejlécet, és kérdezze le a műveletet.