Documentation API
Erreurs
Toutes les erreurs partagent la même forme. Branchez votre logique sur code, jamais sur message.
Forme
{
"error": {
"code": "invalid_request",
"message": "Invalid parameter `limit`: Number must be less than or equal to 100"
}
}code est stable et fait partie du contrat. message est écrit pour l'humain qui débogue : il peut être réécrit, traduit ou précisé à tout moment. Un client qui teste le message casse à la première correction de typographie.
Codes
| Code | Statut | Signification |
|---|---|---|
invalid_request | 400 | Un paramètre a échoué à la validation. Le message nomme lequel. |
invalid_cursor | 400 | Le curseur est illisible. Reprenez page.nextCursor tel quel, sans le décoder. |
unauthorized | 401 | Aucune clé n'a été envoyée, ou l'en-tête n'est pas au format Bearer. |
invalid_key | 401 | La clé est mal formée ou inconnue. |
key_revoked | 401 | La clé a existé mais a été révoquée. Créez-en une nouvelle. |
insufficient_scope | 403 | La clé ne porte pas la portée requise par l'opération. |
account_suspended | 403 | Le compte est suspendu et ne peut pas utiliser l'API. |
cors_not_supported | 403 | Appel depuis une origine navigateur. Cette API s'appelle depuis un serveur. |
not_found | 404 | La ressource n'existe pas, ou n'est pas publique. |
rate_limited | 429 | Plafond de débit atteint. Voir Retry-After. |
internal_error | 500 | Défaut de notre côté. Il est journalisé. |
query_unavailable | 503 | La requête ne peut pas être servie pour le moment — index de stockage en construction. Réessayez. |
Que réessayer
429 et 503 sont temporaires : réessayez, en respectant Retry-After quand il est présent. 400, 401, 403 et 404 ne le sont pas — réessayer à l'identique produira la même réponse.