Faire votre premier appel
Authentifier une requête vers l'API CaptureKit et lire la réponse.
Une fois la clé en main, l'authentification tient dans un en-tête. Cette page montre la forme d'une requête, comment vérifier qu'elle a fonctionné et quoi faire dans le cas contraire.
Réponse
{
"remaining": 42180,
"total_used": 57820,
"renewal_date": "2026-04-01"
}Journaux API
Envoyer la requête
Passez votre clé dans l'en-tête x-api-key à chaque appel. Le point d'accès usage est gratuit, c'est donc le moyen le plus sûr de valider une nouvelle clé :
curl "https://api.capturekit.dev/v1/usage" \
-H "x-api-key: $API_KEY"const res = await fetch("https://api.capturekit.dev/v1/usage", {
headers: { "x-api-key": process.env.API_KEY },
})
if (!res.ok) throw new Error(`Request failed: ${res.status}`)
const usage = await res.json()À quoi ressemble une réponse usage réussie
Un 200 sur le point d'accès usage signifie que la clé fonctionne. Le JSON inclut remaining (marge combinée), les soldes subscription et credits, renewal_date lorsqu'une période s'applique, et l'api_key qui a fait l'appel — y compris ses quotas. Cet appel ne consomme aucun crédit.
Si cela ne fonctionne pas
| Réponse | Cause | Correction |
|---|---|---|
401 Invalid API Key | En-tête absent ou valeur incorrecte | Vérifiez qu'aucun espace ou retour à la ligne n'a été copié avec le secret |
401 Inactive API Key | La clé a été désactivée | Réactivez-la dans Clés API, ou créez-en une nouvelle |
401 Rate limit exceeded | Un quota par clé ou la limite de débit de votre offre a été atteint | Ralentissez le rythme, ou relevez les limites de la clé |
402 Payment required | Plus de crédits, ou une facture impayée | Ajoutez une recharge, activez la recharge automatique, ou réglez la facture |
Réglez le délai d'attente de votre client HTTP sur au moins 60 secondes. Beaucoup de plateformes coupent bien plus tôt et interrompent l'appel avant la réponse de CaptureKit.