REST-API-dokumentasjon
REST-API
Feilkoder
Alle feilkoder API-et returnerer, med HTTP-status, hva de betyr og hva du gjør med dem.
Formen på en feil
Feil er JSON med denne formen. Forgren på code, som aldri endres; message er for mennesker og kan endres. details lister hvert ugyldige felt ved 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Koder
Lenk direkte til en kode med navnet som anker, for eksempel /docs/api/errors#rate_limited.
- 400invalid_request
- Innholdet, spørringen eller en header er ugyldig. details nevner hvert felt med feil. Rett forespørselen; prøver du den igjen uendret, feiler den igjen.
- 401api_key_expired
- Nøkkelen har passert utløpsdatoen. Lag en ny nøkkel, eller bytt ut nøkkelen for å få en ny hemmelighet.
- 401api_key_revoked
- Nøkkelen er trukket tilbake. Lag en ny nøkkel under Innstillinger › Utviklere.
- 401invalid_api_key
- Ingen nøkkel passer. Sjekk at hele nøkkelen ble kopiert, eller lag en ny under Innstillinger › Utviklere.
- 402insufficient_credits
- AI-kredittene til eieren av nøkkelen er brukt opp. Fyll på eller oppgrader i Attorly, og prøv igjen.
- 402usage_limit_exceeded
- En grense for AI-bruk for eieren av nøkkelen eller organisasjonen er nådd. Den nullstilles med faktureringsperioden; en administrator i organisasjonen kan heve grensen for et medlem.
- 403ai_consent_withdrawn
- Eieren av nøkkelen, eller eieren av dokumentet, har trukket tilbake samtykket til AI-behandling. Det kan gis igjen under Innstillinger › Personvern.
- 403forbidden
- Nøkkelen kan lese ressursen, men ikke endre den, eller handlingen er ikke tillatt for den. Be eieren om redigeringstilgang.
- 403insufficient_scope
- Nøkkelen mangler en tilgang denne operasjonen trenger; meldingen sier hvilken. Lag en nøkkel med den tilgangen.
- 403ip_not_allowed
- Nøkkelen har en liste over tillatte IP-adresser, og forespørselen kom fra en adresse utenfor den. Kall fra en tillatt adresse, eller endre listen under Innstillinger › Utviklere.
- 403plan_required
- Abonnementet til eieren av nøkkelen inkluderer ikke API-tilgang, eller eieren har forlatt organisasjonen. API-tilgang krever Pro eller Enterprise.
- 404not_found
- Ressursen finnes ikke, eller denne nøkkelen kan ikke se den. Sjekk id-en, og at eieren av nøkkelen har tilgang.
- 405method_not_allowed
- Stien støtter ikke denne HTTP-metoden. Allow-headeren lister metodene den støtter.
- 409conflict
- Forespørselen er i konflikt med ressursens nåværende tilstand, for eksempel en handling som allerede er gjort. Les ressursen og bestem på nytt.
- 409idempotency_request_in_progress
- En forespørsel med samme Idempotency-Key kjører fortsatt. Hent Location-headeren, eller prøv igjen etter Retry-After sekunder.
- 413payload_too_large
- Innholdet eller den opplastede filen er for stor. Filer kan være opptil 10 MB.
- 415unsupported_media_type
- Innholdet er i et format denne operasjonen ikke tar imot. Send JSON, eller multipart/form-data der opplasting er tillatt.
- 422idempotency_key_reused
- Idempotency-Key ble brukt tidligere for en annen forespørsel. Bruk en ny nøkkel for hver ulike forespørsel.
- 422unprocessable
- Forespørselen er gyldig, men kan ikke utføres, for eksempel en analyse av et dokument uten valgt lovvalg. Meldingen sier hva som mangler.
- 429concurrency_limit_exceeded
- Organisasjonen kjører allerede så mange langvarige AI-operasjoner som den kan samtidig. Vent til én er ferdig, eller i så mange sekunder som står i Retry-After, og prøv igjen.
- 429rate_limited
- For mange forespørsler i ett av vinduene nøkkelen telles mot. Vent så mange sekunder som står i Retry-After, og prøv igjen. RateLimit-headeren viser hvilket vindu som er fullt.
- 500internal_error
- Noe gikk galt hos Attorly. Prøv igjen med samme Idempotency-Key; hvis feilen vedvarer, kontakt support med requestId.
- 504timeout
- Operasjonen ble ikke ferdig i tide. Prøv igjen med samme Idempotency-Key, eller send Prefer: respond-async og hent operasjonen.