Skjölun REST API
REST API
Villukóðar
Allir villukóðar sem API-ið skilar, með HTTP-stöðu, merkingu og því hvað á að gera.
Snið villu
Villur eru JSON með þessu sniði. Byggðu rökfræðina á code, sem breytist aldrei; message er fyrir fólk og getur breyst. details telur upp hvern ógildan reit við 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kóðar
Vísaðu beint á kóða með heiti hans sem akkeri, til dæmis /docs/api/errors#rate_limited.
- 400invalid_request
- Meginmálið, fyrirspurnin eða haus er ógilt. details nefnir hvern reit sem er vandamál. Lagfærðu beiðnina; óbreytt mistekst hún aftur.
- 401api_key_expired
- Lykillinn er útrunninn. Búðu til nýjan lykil eða skiptu honum út til að fá nýtt leyndarmál.
- 401api_key_revoked
- Lykillinn hefur verið afturkallaður. Búðu til nýjan lykil undir Stillingar › Forritarar.
- 401invalid_api_key
- Enginn lykill passar. Athugaðu að allur lykillinn hafi verið afritaður eða búðu til nýjan undir Stillingar › Forritarar.
- 402insufficient_credits
- Gervigreindarinneignir eiganda lykilsins eru uppurnar. Fylltu á eða skiptu um áskrift í Attorly og reyndu aftur.
- 402usage_limit_exceeded
- Gervigreindarnotkunarmörkum eiganda lykilsins eða fyrirtækisins er náð. Þau endurstillast með reikningstímabilinu; stjórnandi fyrirtækisins getur hækkað mörk meðlims.
- 403ai_consent_withdrawn
- Eigandi lykilsins, eða eigandi skjalsins, hefur dregið samþykki sitt fyrir gervigreindarvinnslu til baka. Hægt er að gefa það aftur í persónuverndarstillingum.
- 403forbidden
- Lykillinn má lesa tilfangið en ekki breyta því, eða aðgerðin er ekki leyfð fyrir það. Biddu eigandann um breytingaaðgang.
- 403insufficient_scope
- Lykilinn vantar heimild sem þessi aðgerð þarf; skilaboðin nefna hana. Búðu til lykil með þeirri heimild.
- 403ip_not_allowed
- Lykillinn er með lista yfir leyfð IP-vistföng og beiðnin kom frá vistfangi utan hans. Kallaðu frá leyfðu vistfangi eða breyttu listanum í Stillingar › Forritarar.
- 403plan_required
- Áskrift eiganda lykilsins inniheldur ekki aðgang að API, eða eigandinn hefur yfirgefið fyrirtækið. Aðgangur að API krefst Pro eða Enterprise.
- 404not_found
- Tilfangið er ekki til, eða þessi lykill sér það ekki. Athugaðu auðkennið og að eigandi lykilsins hafi aðgang.
- 405method_not_allowed
- Slóðin styður ekki þessa HTTP-aðferð. Allow-hausinn telur upp studdar aðferðir.
- 409conflict
- Beiðnin stangast á við núverandi stöðu tilfangsins, til dæmis aðgerð sem þegar hefur verið framkvæmd. Lestu tilfangið og ákveddu upp á nýtt.
- 409idempotency_request_in_progress
- Beiðni með sama Idempotency-Key er enn í gangi. Sæktu slóðina í Location-hausnum eða reyndu aftur eftir Retry-After sekúndur.
- 413payload_too_large
- Meginmálið eða skráin sem hlaðið var upp er of stór. Skrár mega vera allt að 10 MB.
- 415unsupported_media_type
- Meginmálið er á sniði sem þessi aðgerð tekur ekki við. Sendu JSON, eða multipart/form-data þar sem upphleðsla er leyfð.
- 422idempotency_key_reused
- Þessi Idempotency-Key hefur þegar verið notaður fyrir aðra beiðni. Notaðu nýjan lykil fyrir hverja ólíka beiðni.
- 422unprocessable
- Beiðnin er gild en ekki er hægt að framkvæma hana, til dæmis greiningu á skjali án valinna gildandi laga. Skilaboðin segja hvað vantar.
- 429concurrency_limit_exceeded
- Fyrirtækið þitt keyrir þegar eins margar langvinnar gervigreindaraðgerðir í einu og leyfilegt er. Bíddu þar til ein klárast, eða í sekúndurnar sem Retry-After segir, og reyndu aftur.
- 429rate_limited
- Of margar beiðnir í einum af gluggunum sem þessi lykill telst í. Bíddu í þann fjölda sekúndna sem Retry-After segir og reyndu aftur. RateLimit-hausinn sýnir hvaða gluggi er fullur.
- 500internal_error
- Eitthvað fór úrskeiðis hjá Attorly. Reyndu aftur með sama Idempotency-Key; ef villan heldur áfram skaltu hafa samband við þjónustuver og gefa upp requestId.
- 504timeout
- Aðgerðinni lauk ekki í tæka tíð. Reyndu aftur með sama Idempotency-Key, eða sendu Prefer: respond-async og sæktu aðgerðina.