Ga naar hoofdinhoud
REST-API-documentatie

REST-API

Foutcodes

Alle foutcodes die de API teruggeeft, met HTTP-status, betekenis en wat je eraan doet.

De vorm van een fout

Fouten zijn JSON in deze vorm. Vertak op code, die nooit verandert; message is voor mensen en kan veranderen. details toont bij een 400 elk ongeldig veld.

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

Codes

Link direct naar een code met de naam als anker, bijvoorbeeld /docs/api/errors#rate_limited.

400invalid_request
De inhoud, de query of een header is ongeldig. details noemt elk veld met een probleem. Corrigeer het verzoek; ongewijzigd opnieuw sturen mislukt opnieuw.
401api_key_expired
De sleutel is verlopen. Maak een nieuwe sleutel, of vervang de sleutel om een nieuw geheim te krijgen.
401api_key_revoked
De sleutel is ingetrokken. Maak een nieuwe sleutel onder Instellingen › Ontwikkelaars.
401invalid_api_key
Geen enkele sleutel komt overeen. Controleer of de hele sleutel is gekopieerd, of maak een nieuwe onder Instellingen › Ontwikkelaars.
401unauthorized
De Authorization-header ontbreekt, of het is niet het woord Bearer gevolgd door de sleutel. Stuur de sleutel als Bearer-token.
402insufficient_credits
De AI-tegoeden van de eigenaar van de sleutel zijn op. Vul aan of stap over in Attorly en probeer het opnieuw.
402usage_limit_exceeded
Een AI-gebruikslimiet van de eigenaar van de sleutel of de organisatie is bereikt. Die wordt gereset met de factuurperiode; een beheerder van de organisatie kan de limiet van een lid verhogen.
403forbidden
De sleutel mag de resource lezen maar niet wijzigen, of de actie is er niet toegestaan. Vraag de eigenaar om bewerkingstoegang.
403insufficient_scope
De sleutel mist een bereik dat deze bewerking nodig heeft; het bericht noemt het. Maak een sleutel met dat bereik.
403ip_not_allowed
De sleutel heeft een lijst met toegestane IP-adressen en het verzoek kwam van een adres daarbuiten. Roep aan vanaf een toegestaan adres of wijzig de lijst via Instellingen › Ontwikkelaars.
403plan_required
Het abonnement van de eigenaar van de sleutel bevat geen API-toegang, of de eigenaar heeft de organisatie verlaten. API-toegang vereist Pro of Enterprise.
404not_found
De resource bestaat niet, of deze sleutel kan hem niet zien. Controleer de id en of de eigenaar van de sleutel toegang heeft.
405method_not_allowed
Het pad ondersteunt deze HTTP-methode niet. De Allow-header toont de ondersteunde methoden.
409conflict
Het verzoek botst met de huidige staat van de resource, bijvoorbeeld een actie die al is uitgevoerd. Lees de resource en beslis opnieuw.
409idempotency_request_in_progress
Een verzoek met dezelfde Idempotency-Key loopt nog. Vraag de Location-header op, of probeer het opnieuw na Retry-After seconden.
413payload_too_large
De inhoud of het geüploade bestand is te groot. Bestanden mogen tot 10 MB zijn.
415unsupported_media_type
De inhoud heeft een formaat dat deze bewerking niet accepteert. Stuur JSON, of multipart/form-data waar uploaden mag.
422idempotency_key_reused
De Idempotency-Key is eerder gebruikt voor een ander verzoek. Gebruik voor elk ander verzoek een nieuwe sleutel.
422unprocessable
Het verzoek is geldig maar kan niet worden uitgevoerd, bijvoorbeeld een analyse van een document zonder gekozen toepasselijk recht. Het bericht zegt wat er ontbreekt.
429concurrency_limit_exceeded
Je organisatie voert al zoveel langlopende AI-operaties tegelijk uit als mag. Wacht tot er een klaar is, of het aantal seconden uit Retry-After, en probeer het opnieuw.
429rate_limited
Te veel verzoeken in een van de vensters waarin deze sleutel meetelt. Wacht het aantal seconden uit Retry-After en probeer het opnieuw. De RateLimit-header laat zien welk venster vol is.
500internal_error
Er ging iets mis bij Attorly. Probeer het opnieuw met dezelfde Idempotency-Key; blijft het misgaan, neem dan contact op met de support met de requestId.
504timeout
De bewerking was niet op tijd klaar. Probeer het opnieuw met dezelfde Idempotency-Key, of stuur Prefer: respond-async en vraag de bewerking op.