REST-API-Dokumentatioun
REST-API
Feelercoden
All Feelercode, deen d'API zréckgëtt, mat sengem HTTP-Status, senger Bedeitung an deem, wat Dir maache kënnt.
D'Form vun de Feeler
Feeler si JSON an dëser Form. Reagéiert op code, dee sech ni ännert; message ass fir Mënschen a ka sech änneren. details lëscht bei engem 400 all ongëltegt Feld op.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Coden
Verlinkt e Code direkt mat sengem Numm als Anker, zum Beispill /docs/api/errors#rate_limited.
- 400invalid_request
- Den Inhalt, d'Query oder en Header ass ongëlteg. details nennt all Feld mat engem Problem. Korrigéiert d'Ufro; wann Dir se onverännert nees schéckt, schléit se nees feel.
- 401api_key_expired
- De Schlëssel huet säin Oflafdatum iwwerschratt. Leet en neie Schlëssel un, oder ersetzt de Schlëssel, fir en neie Secret ze kréien.
- 401api_key_revoked
- De Schlëssel gouf widderruff. Leet ënner Astellungen › Entwéckler en neie Schlëssel un.
- 401invalid_api_key
- Kee Schlëssel passt. Kontrolléiert, ob de ganze Schlëssel kopéiert gouf, oder leet ënner Astellungen › Entwéckler en neien un.
- 402insufficient_credits
- D'KI-Credits vum Proprietär vum Schlëssel sinn opgebraucht. Luet an Attorly op oder wiesselt op e méi héijen Abonnement a probéiert et dann nach eng Kéier.
- 402usage_limit_exceeded
- Eng Limitt fir d'KI-Notzung vum Proprietär vum Schlëssel oder vun der Organisatioun ass erreecht. Si gëtt mat der Ofrechnungsperiod zréckgesat; en Administrateur vun der Organisatioun ka d'Limitt vun engem Member erhéijen.
- 403ai_consent_withdrawn
- De Proprietär vum Schlëssel oder de Proprietär vum Dokument huet seng Zoustëmmung zur KI-Veraarbechtung zréckgezunn. Si kann ënner Astellungen › Dateschutz nees gi ginn.
- 403forbidden
- De Schlëssel däerf d'Ressource liesen, mä net änneren, oder d'Aktioun ass fir se net erlaabt. Frot de Proprietär no Beaarbechtungszougang.
- 403insufficient_scope
- Dem Schlëssel feelt eng Berechtegung, déi dës Operatioun brauch; de message nennt se. Leet e Schlëssel mat dëser Berechtegung un.
- 403ip_not_allowed
- De Schlëssel huet eng IP-Allowlist, an d'Ufro koum vun enger Adress ausserhalb dovun. Rufft vun enger erlaabter Adress aus op, oder ännert d'Allowlist ënner Astellungen › Entwéckler.
- 403plan_required
- D'Abonnement vum Proprietär vum Schlëssel enthält keen API-Zougang, oder de Proprietär huet d'Organisatioun verlooss. Fir den API-Zougang braucht et Pro oder Enterprise.
- 404not_found
- D'Ressource existéiert net, oder dëse Schlëssel kann se net gesinn. Kontrolléiert d'ID an ob de Proprietär vum Schlëssel Zougang huet.
- 405method_not_allowed
- De Pad ënnerstëtzt dës HTTP-Method net. Den Allow-Header lëscht d'Methoden op, déi en ënnerstëtzt.
- 409conflict
- D'Ufro steet a Konflikt mam aktuellen Zoustand vun der Ressource, zum Beispill eng Aktioun, déi schonn duerchgefouert gouf. Liest d'Ressource an decidéiert nach eng Kéier.
- 409idempotency_request_in_progress
- Eng Ufro mam selwechten Idempotency-Key leeft nach. Frot de Location-Header reegelméisseg of, oder probéiert et no Retry-After Sekonnen nach eng Kéier.
- 413payload_too_large
- Den Inhalt oder den eropgeluedene Fichier ass ze grouss. Fichiere kënne bis zu 10 MB grouss sinn.
- 415unsupported_media_type
- Den Inhalt ass an engem Format, dat dës Operatioun net akzeptéiert. Schéckt JSON, oder multipart/form-data, wou en Upload akzeptéiert gëtt.
- 422idempotency_key_reused
- Den Idempotency-Key gouf scho fir eng aner Ufro benotzt. Benotzt fir all ënnerschiddlech Ufro en neie Schlëssel.
- 422unprocessable
- D'Ufro ass gëlteg, ka mä net ausgefouert ginn, zum Beispill eng Analyse vun engem Dokument, fir dat keen applicabelt Recht gewielt gouf. De message seet, wat feelt.
- 429concurrency_limit_exceeded
- Är Organisatioun féiert schonn esou vill laang KI-Operatioune gläichzäiteg aus, wéi se däerf. Waart, bis eng fäerdeg ass, oder d'Sekonnen a Retry-After, a probéiert et dann nach eng Kéier.
- 429rate_limited
- Ze vill Ufroen an enger vun den Zäitfënsteren, fir déi dëse Schlëssel zielt. Waart d'Zuel vu Sekonnen a Retry-After a probéiert et dann nach eng Kéier. De RateLimit-Header weist, wéi eng Fënster voll ass.
- 500internal_error
- Bei Attorly ass eppes schifgaang. Probéiert et mam selwechten Idempotency-Key nach eng Kéier; wann de Problem bleift, kontaktéiert de Support mat der requestId.
- 504timeout
- D'Operatioun gouf net an der Zäit fäerdeg. Probéiert et mam selwechten Idempotency-Key nach eng Kéier, oder schéckt Prefer: respond-async a frot d'Operatioun reegelméisseg of.