REST-API

Fejlkoder

Name: Attorly AI
Availability: InStock

Alle fejlkoder, API'et returnerer, med HTTP-status, hvad de betyder, og hvad du skal gøre ved dem.

Fejlens form

Fejl er JSON med denne form. Forgren på code, som aldrig ændres; message er til mennesker og kan ændres. details viser hvert ugyldigt felt ved 400.

json

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

Koder

Link direkte til en kode med dens navn som anker, for eksempel /docs/api/errors#rate_limited.

400invalid_request: Indholdet, forespørgslen eller en header er ugyldig. details nævner hvert felt med fejl. Ret forespørgslen; sender du den uændret igen, fejler den igen.
401api_key_expired: Nøglen har passeret sin udløbsdato. Opret en ny nøgle, eller udskift nøglen for at få en ny hemmelighed.
401api_key_revoked: Nøglen er tilbagekaldt. Opret en ny nøgle under Indstillinger › Udviklere.
401invalid_api_key: Ingen nøgle passer. Tjek at hele nøglen blev kopieret, eller opret en ny under Indstillinger › Udviklere.
401unauthorized: Authorization-headeren mangler, eller den er ikke ordet Bearer efterfulgt af nøglen. Send nøglen som Bearer-token.
402insufficient_credits: Nøgleejerens AI-kreditter er opbrugt. Fyld op eller opgradér i Attorly, og prøv igen.
402usage_limit_exceeded: En grænse for AI-forbrug for nøgleejeren eller organisationen er nået. Den nulstilles med faktureringsperioden; en administrator i organisationen kan hæve et medlems grænse.
403ai_consent_withdrawn: Nøgleejeren, eller dokumentets ejer, har trukket samtykket til AI-behandling tilbage. Det kan gives igen i privatlivsindstillingerne.
403forbidden: Nøglen må læse ressourcen, men ikke ændre den, eller handlingen er ikke tilladt for den. Bed ejeren om redigeringsadgang.
403insufficient_scope: Nøglen mangler en rettighed, denne operation kræver; beskeden nævner den. Opret en nøgle med den rettighed.
403ip_not_allowed: Nøglen har en liste over tilladte IP-adresser, og forespørgslen kom fra en adresse uden for den. Kald fra en tilladt adresse, eller ændr listen under Indstillinger › Udviklere.
403plan_required: Nøgleejerens abonnement omfatter ikke API-adgang, eller ejeren har forladt organisationen. API-adgang kræver Pro eller Enterprise.
404not_found: Ressourcen findes ikke, eller nøglen kan ikke se den. Tjek id'et, og at nøgleejeren har adgang.
405method_not_allowed: Stien understøtter ikke denne HTTP-metode. Allow-headeren viser de metoder, den understøtter.
409conflict: Forespørgslen er i konflikt med ressourcens nuværende tilstand, fx en handling der allerede er udført. Læs ressourcen, og beslut igen.
409idempotency_request_in_progress: En forespørgsel med samme Idempotency-Key kører stadig. Hent Location-headeren, eller prøv igen efter Retry-After sekunder.
413payload_too_large: Indholdet eller den uploadede fil er for stor. Filer må være op til 10 MB.
415unsupported_media_type: Indholdet er i et format, operationen ikke tager imod. Send JSON, eller multipart/form-data hvor upload er tilladt.
422idempotency_key_reused: Idempotency-Key blev brugt før til en anden forespørgsel. Brug en ny nøgle til hver forskellig forespørgsel.
422unprocessable: Forespørgslen er gyldig, men kan ikke udføres, fx en analyse af et dokument uden valgt lovvalg. Beskeden siger, hvad der mangler.
429concurrency_limit_exceeded: Organisationen kører allerede så mange langvarige AI-operationer ad gangen, som den må. Vent, til én er færdig, eller det antal sekunder, der står i Retry-After, og prøv igen.
429rate_limited: For mange forespørgsler i et af de vinduer, nøglen tæller mod. Vent det antal sekunder, der står i Retry-After, og prøv igen. RateLimit-headeren viser, hvilket vindue der er fyldt.
500internal_error: Noget gik galt hos Attorly. Prøv igen med samme Idempotency-Key; fortsætter fejlen, så kontakt support med requestId.
504timeout: Operationen blev ikke færdig i tide. Prøv igen med samme Idempotency-Key, eller send Prefer: respond-async, og hent operationen.