REST-rajapinnan dokumentaatio
REST-rajapinta
Virhekoodit
Kaikki rajapinnan palauttamat virhekoodit HTTP-tiloineen: mitä ne tarkoittavat ja mitä niille tehdään.
Virheen muoto
Virheet ovat tämän muotoista JSONia. Haarauta kentän code mukaan, joka ei koskaan muutu; message on ihmisille ja voi muuttua. details listaa jokaisen virheellisen kentän, kun tila on 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Koodit
Linkitä koodiin suoraan käyttämällä sen nimeä ankkurina, esimerkiksi /docs/api/errors#rate_limited.
- 400invalid_request
- Sisältö, kysely tai otsake on virheellinen. details nimeää jokaisen ongelmakentän. Korjaa pyyntö; muuttamattomana se epäonnistuu uudelleen.
- 401api_key_expired
- Avain on vanhentunut. Luo uusi avain tai vaihda avain saadaksesi uuden salaisuuden.
- 401api_key_revoked
- Avain on mitätöity. Luo uusi avain kohdassa Asetukset › Kehittäjät.
- 401invalid_api_key
- Mikään avain ei täsmää. Tarkista, että koko avain kopioitiin, tai luo uusi kohdassa Asetukset › Kehittäjät.
- 402insufficient_credits
- Avaimen omistajan tekoälykrediitit ovat loppuneet. Täydennä tai vaihda tilausta Attorlyssa ja yritä uudelleen.
- 402usage_limit_exceeded
- Avaimen omistajan tai organisaation tekoälyn käyttöraja on täynnä. Se nollautuu laskutuskauden myötä; organisaation ylläpitäjä voi nostaa jäsenen rajaa.
- 403ai_consent_withdrawn
- Avaimen tai asiakirjan omistaja on perunut suostumuksensa tekoälykäsittelyyn. Suostumuksen voi antaa uudelleen tietosuoja-asetuksissa.
- 403forbidden
- Avain saa lukea resurssin mutta ei muuttaa sitä, tai toimintoa ei sallita sille. Pyydä omistajalta muokkausoikeus.
- 403insufficient_scope
- Avaimelta puuttuu oikeus, jota toiminto tarvitsee; viesti nimeää sen. Luo avain, jolla on tämä oikeus.
- 403ip_not_allowed
- Avaimella on sallittujen IP-osoitteiden luettelo, ja pyyntö tuli sen ulkopuolisesta osoitteesta. Kutsu sallitusta osoitteesta tai muuta luetteloa kohdassa Asetukset › Kehittäjät.
- 403plan_required
- Avaimen omistajan tilaus ei sisällä API-käyttöä, tai omistaja on poistunut organisaatiosta. API-käyttö vaatii Pro- tai Enterprise-tilauksen.
- 404not_found
- Resurssia ei ole olemassa, tai tämä avain ei näe sitä. Tarkista tunnus ja se, että avaimen omistajalla on pääsy.
- 405method_not_allowed
- Polku ei tue tätä HTTP-metodia. Allow-otsake listaa tuetut metodit.
- 409conflict
- Pyyntö on ristiriidassa resurssin nykyisen tilan kanssa, esimerkiksi jo tehty toiminto. Lue resurssi ja päätä uudelleen.
- 409idempotency_request_in_progress
- Pyyntö samalla Idempotency-Keyllä on yhä käynnissä. Kysele Location-otsakkeen osoitetta tai yritä uudelleen Retry-After-sekuntien kuluttua.
- 413payload_too_large
- Sisältö tai ladattu tiedosto on liian suuri. Tiedostot voivat olla enintään 10 Mt.
- 415unsupported_media_type
- Sisältö on muodossa, jota tämä toiminto ei hyväksy. Lähetä JSONia, tai multipart/form-dataa, jos lataus on sallittu.
- 422idempotency_key_reused
- Idempotency-Keytä on käytetty aiemmin toiseen pyyntöön. Käytä jokaiselle eri pyynnölle uutta avainta.
- 422unprocessable
- Pyyntö on kelvollinen mutta sitä ei voi suorittaa, esimerkiksi analyysi asiakirjasta, jolle ei ole valittu sovellettavaa lakia. Viesti kertoo, mitä puuttuu.
- 429concurrency_limit_exceeded
- Organisaatiollasi on jo käynnissä niin monta pitkäkestoista AI-operaatiota kuin samanaikaisesti saa olla. Odota, että yksi valmistuu, tai Retry-Afterin sekunnit, ja yritä uudelleen.
- 429rate_limited
- Liian monta pyyntöä jossakin ikkunassa, johon tämä avain lasketaan. Odota Retry-Afterissa ilmoitettu määrä sekunteja ja yritä uudelleen. RateLimit-otsake kertoo, mikä ikkuna on täynnä.
- 500internal_error
- Attorlyssa meni jokin vikaan. Yritä uudelleen samalla Idempotency-Keyllä; jos virhe jatkuu, ota yhteyttä tukeen ja kerro requestId.
- 504timeout
- Toiminto ei valmistunut ajoissa. Yritä uudelleen samalla Idempotency-Keyllä, tai lähetä Prefer: respond-async ja kysele toimintoa.