Aqbeż għall-kontenut ewlieni
Dokumentazzjoni tar-REST API

REST API

Kodiċijiet tal-iżbalji

Kull kodiċi ta' żball li tirritorna l-API, bl-istatus HTTP tiegħu, xi jfisser u x'għandek tagħmel dwaru.

Il-forma tal-iżball

L-iżbalji huma JSON b'din il-forma. Agħżel fuq code, li qatt ma jinbidel; message huwa għan-nies u jista' jinbidel. details jelenka kull qasam invalidu għal 400.

json
{
  "error": {
    "code": "insufficient_scope",
    "message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
    "requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
  }
}

Kodiċijiet

Għamel link direttament għal kodiċi b'ismu bħala l-ankra, pereżempju /docs/api/errors#rate_limited.

400invalid_request
Il-kontenut, il-query jew header mhux validi. details isemmi kull qasam problematiku. Irranġa t-talba; jekk terġa' tippruvaha mingħajr bidla, terġa' tfalli.
401api_key_expired
Il-key qabżet id-data tal-iskadenza tagħha. Oħloq key ġdida, jew dawwar il-key biex tikseb sigriet ġdid.
401api_key_revoked
Il-key ġiet revokata. Oħloq key ġdida f'Issettjar › Żviluppaturi.
401invalid_api_key
L-ebda key ma taqbel. Iċċekkja li l-key kollha ġiet ikkupjata, jew oħloq waħda ġdida f'Issettjar › Żviluppaturi.
401unauthorized
Il-header Authorization huwa nieqes, jew mhuwiex il-kelma Bearer segwita mill-key. Ibgħat il-key bħala Bearer token.
402insufficient_credits
Il-krediti tal-AI tas-sid tal-key spiċċaw. Żid jew aġġorna l-pjan f'Attorly, imbagħad erġa' pprova.
402usage_limit_exceeded
Intlaħaq limitu tal-użu tal-AI għas-sid tal-key jew għall-organizzazzjoni. Jerġa' jibda mal-perjodu tal-fatturazzjoni; amministratur tal-organizzazzjoni jista' jgħolli l-limitu ta' membru.
403forbidden
Il-key tista' taqra r-riżorsa iżda mhux tbiddilha, jew l-azzjoni mhijiex permessa għaliha. Itlob lis-sid aċċess għall-editjar.
403insufficient_scope
Il-key m'għandhiex permess li teħtieġ din l-operazzjoni; il-messaġġ isemmih. Oħloq key b'dak il-permess.
403ip_not_allowed
Il-key għandha lista ta' IPs permessi u t-talba waslet minn indirizz barra minnha. Sejjaħ minn indirizz permess, jew ibdel il-lista f'Issettjar › Żviluppaturi.
403plan_required
Il-pjan tas-sid tal-key ma jinkludix aċċess għall-API, jew is-sid ħalla l-organizzazzjoni. L-aċċess għall-API jeħtieġ Pro jew Enterprise.
404not_found
Ir-riżorsa ma teżistix, jew din il-key ma tistax taraha. Iċċekkja l-id u li s-sid tal-key għandu aċċess.
405method_not_allowed
Il-mogħdija ma tappoġġax dan il-metodu HTTP. Il-header Allow jelenka l-metodi li tappoġġa.
409conflict
It-talba tmur kontra l-istat attwali tar-riżorsa, pereżempju azzjoni li diġà saret. Aqra r-riżorsa u erġa' iddeċiedi.
409idempotency_request_in_progress
Talba bl-istess Idempotency-Key għadha għaddejja. Iċċekkja l-header Location ripetutament, jew erġa' pprova wara s-sekondi ta' Retry-After.
413payload_too_large
Il-kontenut jew il-fajl imtella' huwa kbir wisq. Il-fajls jistgħu jkunu sa 10 MB.
415unsupported_media_type
Il-kontenut huwa f'format li din l-operazzjoni ma taċċettax. Ibgħat JSON, jew multipart/form-data fejn tellgħa hija aċċettata.
422idempotency_key_reused
L-Idempotency-Key intużat qabel għal talba differenti. Uża key ġdida għal kull talba distinta.
422unprocessable
It-talba hija valida iżda ma tistax issir, pereżempju analiżi ta' dokument mingħajr liġi applikabbli magħżula. Il-messaġġ jgħid x'inhu nieqes.
429concurrency_limit_exceeded
L-organizzazzjoni tiegħek diġà qed tħaddem l-akbar numru ta' operazzjonijiet tal-AI li jdumu ħafna li tista' f'daqqa. Stenna li titlesta waħda, jew is-sekondi f'Retry-After, imbagħad erġa' pprova.
429rate_limited
Wisq talbiet f'waħda mit-twieqi li kontriha tgħodd din il-key. Stenna n-numru ta' sekondi f'Retry-After, imbagħad erġa' pprova. Il-header RateLimit juri liema tieqa hija mimlija.
500internal_error
Xi ħaġa marret ħażin f'Attorly. Erġa' pprova bl-istess Idempotency-Key; jekk tippersisti, ikkuntattja l-appoġġ bir-requestId.
504timeout
L-operazzjoni ma tlestietx fil-ħin. Erġa' pprova bl-istess Idempotency-Key, jew ibgħat Prefer: respond-async u ċċekkja l-operazzjoni ripetutament.