REST-API-dokumentation
REST-API
Felkoder
Alla felkoder som API:t returnerar, med HTTP-status, vad de betyder och vad du ska göra åt dem.
Felets form
Fel är JSON med den här formen. Förgrena på code, som aldrig ändras; message är för människor och kan ändras. details listar varje ogiltigt fält vid 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Koder
Länka direkt till en kod med dess namn som ankare, till exempel /docs/api/errors#rate_limited.
- 400invalid_request
- Innehållet, frågan eller en header är ogiltig. details nämner varje fält med fel. Rätta begäran; skickar du den oförändrad igen misslyckas den igen.
- 401api_key_expired
- Nyckeln har passerat sitt utgångsdatum. Skapa en ny nyckel, eller byt ut nyckeln för att få en ny hemlighet.
- 401api_key_revoked
- Nyckeln har återkallats. Skapa en ny nyckel under Inställningar › Utvecklare.
- 401invalid_api_key
- Ingen nyckel matchar. Kontrollera att hela nyckeln kopierades, eller skapa en ny under Inställningar › Utvecklare.
- 402insufficient_credits
- Nyckelägarens AI-krediter är slut. Fyll på eller uppgradera i Attorly och försök igen.
- 402usage_limit_exceeded
- En gräns för AI-användning för nyckelägaren eller organisationen är nådd. Den nollställs med faktureringsperioden; en administratör i organisationen kan höja en medlems gräns.
- 403ai_consent_withdrawn
- Nyckelägaren, eller dokumentets ägare, har återkallat sitt samtycke till AI-behandling. Det kan ges igen i integritetsinställningarna.
- 403forbidden
- Nyckeln får läsa resursen men inte ändra den, eller så är åtgärden inte tillåten för den. Be ägaren om redigeringsåtkomst.
- 403insufficient_scope
- Nyckeln saknar en behörighet som operationen kräver; meddelandet anger vilken. Skapa en nyckel med den behörigheten.
- 403ip_not_allowed
- Nyckeln har en lista över tillåtna IP-adresser och anropet kom från en adress utanför den. Anropa från en tillåten adress eller ändra listan under Inställningar › Utvecklare.
- 403plan_required
- Nyckelägarens abonnemang omfattar inte API-åtkomst, eller så har ägaren lämnat organisationen. API-åtkomst kräver Pro eller Enterprise.
- 404not_found
- Resursen finns inte, eller så kan nyckeln inte se den. Kontrollera id:t och att nyckelägaren har åtkomst.
- 405method_not_allowed
- Sökvägen stöder inte den här HTTP-metoden. Allow-headern listar de metoder den stöder.
- 409conflict
- Begäran står i konflikt med resursens nuvarande tillstånd, till exempel en åtgärd som redan är gjord. Läs resursen och bestäm igen.
- 409idempotency_request_in_progress
- En begäran med samma Idempotency-Key körs fortfarande. Hämta Location-headern, eller försök igen efter Retry-After sekunder.
- 413payload_too_large
- Innehållet eller den uppladdade filen är för stor. Filer får vara upp till 10 MB.
- 415unsupported_media_type
- Innehållet har ett format som operationen inte tar emot. Skicka JSON, eller multipart/form-data där uppladdning tillåts.
- 422idempotency_key_reused
- Idempotency-Key har använts tidigare för en annan begäran. Använd en ny nyckel för varje unik begäran.
- 422unprocessable
- Begäran är giltig men kan inte utföras, till exempel en analys av ett dokument utan vald tillämplig lag. Meddelandet anger vad som saknas.
- 429concurrency_limit_exceeded
- Organisationen kör redan så många långvariga AI-operationer som den får samtidigt. Vänta tills en är klar, eller så många sekunder som anges i Retry-After, och försök igen.
- 429rate_limited
- För många anrop i ett av fönstren som nyckeln räknas mot. Vänta så många sekunder som anges i Retry-After och försök igen. RateLimit-headern visar vilket fönster som är fullt.
- 500internal_error
- Något gick fel hos Attorly. Försök igen med samma Idempotency-Key; om felet kvarstår, kontakta support med requestId.
- 504timeout
- Operationen blev inte klar i tid. Försök igen med samma Idempotency-Key, eller skicka Prefer: respond-async och hämta operationen.