REST-API

Fehlercodes

Name: Attorly AI
Availability: InStock

Alle Fehlercodes, die die API zurückgibt, mit HTTP-Status, Bedeutung und dem, was zu tun ist.

Die Form eines Fehlers

Fehler sind JSON in dieser Form. Verzweigen Sie anhand von code, der sich nie ändert; message ist für Menschen und kann sich ändern. details listet bei 400 jedes ungültige Feld.

json

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

Codes

Verlinken Sie einen Code direkt mit seinem Namen als Anker, zum Beispiel /docs/api/errors#rate_limited.

400invalid_request: Inhalt, Abfrage oder ein Header ist ungültig. details nennt jedes fehlerhafte Feld. Korrigieren Sie die Anfrage; unverändert wiederholt schlägt sie erneut fehl.
401api_key_expired: Der Schlüssel ist abgelaufen. Erstellen Sie einen neuen Schlüssel oder erneuern Sie ihn, um ein neues Geheimnis zu erhalten.
401api_key_revoked: Der Schlüssel wurde widerrufen. Erstellen Sie unter Einstellungen › Entwickler einen neuen Schlüssel.
401invalid_api_key: Kein Schlüssel passt. Prüfen Sie, ob der vollständige Schlüssel kopiert wurde, oder erstellen Sie unter Einstellungen › Entwickler einen neuen.
401unauthorized: Der Authorization-Header fehlt oder besteht nicht aus dem Wort Bearer gefolgt vom Schlüssel. Senden Sie den Schlüssel als Bearer-Token.
402insufficient_credits: Das KI-Guthaben der Person, der der Schlüssel gehört, ist aufgebraucht. Laden Sie in Attorly auf oder wechseln Sie den Tarif, und versuchen Sie es erneut.
402usage_limit_exceeded: Ein KI-Nutzungslimit der Person oder der Organisation ist erreicht. Es wird mit dem Abrechnungszeitraum zurückgesetzt; eine Administratorin oder ein Administrator der Organisation kann das Limit eines Mitglieds erhöhen.
403ai_consent_withdrawn: Die Person, der der Schlüssel oder das Dokument gehört, hat die Einwilligung zur KI-Verarbeitung widerrufen. Sie kann in den Datenschutzeinstellungen erneut erteilt werden.
403forbidden: Der Schlüssel darf die Ressource lesen, aber nicht ändern, oder die Aktion ist für sie nicht erlaubt. Bitten Sie die Eigentümerin oder den Eigentümer um Bearbeitungszugriff.
403insufficient_scope: Dem Schlüssel fehlt eine Berechtigung, die diese Operation benötigt; die Nachricht nennt sie. Erstellen Sie einen Schlüssel mit dieser Berechtigung.
403ip_not_allowed: Der Schlüssel hat eine IP-Freigabeliste, und die Anfrage kam von einer Adresse außerhalb davon. Rufen Sie von einer erlaubten Adresse auf oder ändern Sie die Liste unter Einstellungen › Entwickler.
403plan_required: Der Tarif der Person, der der Schlüssel gehört, umfasst keinen API-Zugang, oder sie hat die Organisation verlassen. API-Zugang erfordert Pro oder Enterprise.
404not_found: Die Ressource existiert nicht, oder dieser Schlüssel kann sie nicht sehen. Prüfen Sie die ID und ob die Person, der der Schlüssel gehört, Zugriff hat.
405method_not_allowed: Der Pfad unterstützt diese HTTP-Methode nicht. Der Allow-Header listet die unterstützten Methoden.
409conflict: Die Anfrage steht im Konflikt mit dem aktuellen Zustand der Ressource, etwa bei einer bereits erledigten Aktion. Lesen Sie die Ressource und entscheiden Sie neu.
409idempotency_request_in_progress: Eine Anfrage mit demselben Idempotency-Key läuft noch. Rufen Sie den Location-Header ab, oder versuchen Sie es nach Retry-After Sekunden erneut.
413payload_too_large: Inhalt oder hochgeladene Datei ist zu groß. Dateien dürfen bis zu 10 MB groß sein.
415unsupported_media_type: Der Inhalt hat ein Format, das diese Operation nicht annimmt. Senden Sie JSON, oder multipart/form-data, wo ein Upload möglich ist.
422idempotency_key_reused: Der Idempotency-Key wurde bereits für eine andere Anfrage verwendet. Verwenden Sie für jede unterschiedliche Anfrage einen neuen Schlüssel.
422unprocessable: Die Anfrage ist gültig, kann aber nicht ausgeführt werden, etwa die Analyse eines Dokuments ohne gewähltes anwendbares Recht. Die Nachricht sagt, was fehlt.
429concurrency_limit_exceeded: Ihre Organisation führt bereits so viele lang laufende KI-Operationen gleichzeitig aus, wie sie darf. Warten Sie, bis eine fertig ist, oder die Sekunden aus Retry-After ab, und versuchen Sie es erneut.
429rate_limited: Zu viele Anfragen in einem der Fenster, gegen die dieser Schlüssel zählt. Warten Sie die Sekunden aus Retry-After ab und versuchen Sie es erneut. Der RateLimit-Header zeigt, welches Fenster voll ist.
500internal_error: Bei Attorly ist etwas schiefgegangen. Versuchen Sie es mit demselben Idempotency-Key erneut; besteht der Fehler weiter, wenden Sie sich mit der requestId an den Support.
504timeout: Die Operation wurde nicht rechtzeitig fertig. Versuchen Sie es mit demselben Idempotency-Key erneut, oder senden Sie Prefer: respond-async und rufen Sie die Operation ab.