API REST

Codes d’erreur

Tous les codes d’erreur renvoyés par l’API, avec leur statut HTTP, leur signification et la marche à suivre.

La forme d’une erreur

Les erreurs sont du JSON de cette forme. Basez votre logique sur code, qui ne change jamais ; message s’adresse aux humains et peut changer. details liste chaque champ invalide pour un 400.

json

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

Codes

Créez un lien direct vers un code avec son nom comme ancre, par exemple /docs/api/errors#rate_limited.

400invalid_request: Le corps, la requête ou un en-tête n’est pas valide. details nomme chaque champ en cause. Corrigez la requête : renvoyée telle quelle, elle échouera encore.
401api_key_expired: La clé a dépassé sa date d’expiration. Créez une nouvelle clé, ou renouvelez-la pour obtenir un nouveau secret.
401api_key_revoked: La clé a été révoquée. Créez une nouvelle clé dans Paramètres › Développeurs.
401invalid_api_key: Aucune clé ne correspond. Vérifiez que la clé a été copiée en entier, ou créez-en une dans Paramètres › Développeurs.
401unauthorized: L’en-tête Authorization est absent, ou il ne contient pas le mot Bearer suivi de la clé. Envoyez la clé comme jeton Bearer.
402insufficient_credits: Les crédits IA du titulaire de la clé sont épuisés. Rechargez ou changez d’offre dans Attorly, puis réessayez.
402usage_limit_exceeded: Une limite d’utilisation de l’IA du titulaire de la clé ou de l’organisation est atteinte. Elle se réinitialise avec la période de facturation ; un administrateur de l’organisation peut relever la limite d’un membre.
403ai_consent_withdrawn: Le titulaire de la clé, ou le propriétaire du document, a retiré son consentement au traitement par IA. Il peut le redonner dans les paramètres de confidentialité.
403forbidden: La clé peut lire la ressource mais pas la modifier, ou l’action n’y est pas autorisée. Demandez au propriétaire un accès en modification.
403insufficient_scope: Il manque à la clé une autorisation requise par cette opération ; le message la nomme. Créez une clé avec cette autorisation.
403ip_not_allowed: La clé a une liste d’adresses IP autorisées et la requête provenait d’une adresse hors de cette liste. Appelez depuis une adresse autorisée, ou modifiez la liste dans Paramètres › Développeurs.
403plan_required: L’offre du titulaire de la clé n’inclut pas l’accès à l’API, ou il a quitté l’organisation. L’accès à l’API requiert Pro ou Enterprise.
404not_found: La ressource n’existe pas, ou cette clé ne peut pas la voir. Vérifiez l’identifiant et que le titulaire de la clé y a accès.
405method_not_allowed: Ce chemin ne prend pas en charge cette méthode HTTP. L’en-tête Allow liste les méthodes prises en charge.
409conflict: La requête entre en conflit avec l’état actuel de la ressource, par exemple une action déjà effectuée. Relisez la ressource et décidez à nouveau.
409idempotency_request_in_progress: Une requête avec la même Idempotency-Key est encore en cours. Interrogez l’en-tête Location, ou réessayez après Retry-After secondes.
413payload_too_large: Le corps ou le fichier téléversé est trop volumineux. Les fichiers peuvent atteindre 10 Mo.
415unsupported_media_type: Le corps est dans un format que cette opération n’accepte pas. Envoyez du JSON, ou du multipart/form-data lorsque le téléversement est accepté.
422idempotency_key_reused: Cette Idempotency-Key a déjà servi pour une autre requête. Utilisez une nouvelle clé pour chaque requête distincte.
422unprocessable: La requête est valide mais ne peut pas être exécutée, par exemple l’analyse d’un document sans droit applicable choisi. Le message indique ce qui manque.
429concurrency_limit_exceeded: Votre organisation exécute déjà autant d’opérations IA de longue durée simultanées qu’elle le peut. Attendez qu’une se termine, ou le nombre de secondes indiqué dans Retry-After, puis réessayez.
429rate_limited: Trop de requêtes dans l’une des fenêtres où cette clé est comptée. Attendez le nombre de secondes indiqué dans Retry-After, puis réessayez. L’en-tête RateLimit indique quelle fenêtre est pleine.
500internal_error: Un problème est survenu chez Attorly. Réessayez avec la même Idempotency-Key ; si cela persiste, contactez le support avec le requestId.
504timeout: L’opération n’a pas abouti à temps. Réessayez avec la même Idempotency-Key, ou envoyez Prefer: respond-async et interrogez l’opération.