The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

L’API d’administration d’utilisation et de coût fournit un accès programmatique et granulaire aux données historiques d’utilisation et de coût de l’API pour votre organisation. Ces données sont similaires aux informations disponibles dans les pages Utilisation et Coût de la Console Anthropic.

Cette API vous permet de mieux surveiller, analyser et optimiser vos implémentations Claude :

  • Suivi précis de l’utilisation : Obtenez des comptes de jetons précis et des modèles d’utilisation au lieu de vous fier uniquement au comptage des jetons de réponse
  • Réconciliation des coûts : Faites correspondre les enregistrements internes avec la facturation Anthropic pour les équipes financières et comptables
  • Performance et amélioration du produit : Surveillez les performances du produit tout en mesurant si les changements apportés au système l’ont amélioré, ou configurez des alertes
  • Optimisation des limites de taux et du niveau de priorité : Optimisez des fonctionnalités comme la mise en cache des invites ou des invites spécifiques pour tirer le meilleur parti de votre capacité allouée, ou achetez une capacité dédiée.
  • Analyse avancée : Effectuez une analyse de données plus approfondie que ce qui est disponible dans la Console

Clé API d’administration requise

Cette API fait partie de l’API d’administration. Ces points de terminaison nécessitent une clé API d’administration (commençant par sk-ant-admin...) qui diffère des clés API standard. Seuls les membres de l’organisation ayant le rôle d’administrateur peuvent provisionner des clés API d’administration via la Console Anthropic.

Solutions partenaires

Les principales plateformes d’observabilité offrent des intégrations prêtes à l’emploi pour surveiller votre utilisation et vos coûts de l’API Claude, sans écrire de code personnalisé. Ces intégrations fournissent des tableaux de bord, des alertes et des analyses pour vous aider à gérer efficacement votre utilisation de l’API.

Démarrage rapide

Obtenez l’utilisation quotidienne de votre organisation pour les 7 derniers jours :

curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-08T00:00:00Z&\
ending_at=2025-01-15T00:00:00Z&\
bucket_width=1d" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

Définissez un en-tête User-Agent pour les intégrations

Si vous créez une intégration, définissez votre en-tête User-Agent pour nous aider à comprendre les modèles d’utilisation :

User-Agent: VotreApp/1.0.0 (https://votreapp.com)

API d’utilisation

Suivez la consommation de jetons dans votre organisation avec des répartitions détaillées par modèle, espace de travail et niveau de service avec le point de terminaison /v1/organizations/usage_report/messages.

Concepts clés

  • Buckets de temps : Agrégez les données d’utilisation par intervalles fixes (1m, 1h, ou 1d)
  • Suivi des jetons : Mesurez les jetons d’entrée non mis en cache, les jetons d’entrée mis en cache, la création de cache et les jetons de sortie
  • Filtrage et regroupement : Filtrez par clé API, espace de travail, modèle, niveau de service ou fenêtre de contexte, et regroupez les résultats par ces dimensions
  • Utilisation d’outils serveur : Suivez l’utilisation d’outils côté serveur comme la recherche web

Pour les détails complets des paramètres et les schémas de réponse, consultez la référence de l’API d’utilisation.

Exemples de base

Utilisation quotidienne par modèle

curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-08T00:00:00Z&\
group_by[]=model&\
bucket_width=1d" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

Utilisation horaire avec filtrage

curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-15T00:00:00Z&\
ending_at=2025-01-15T23:59:59Z&\
models[]=claude-sonnet-4-20250514&\
service_tiers[]=batch&\
context_window[]=0-200k&\
bucket_width=1h" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

Limites de granularité temporelle

GranularitéLimite par défautLimite maximaleCas d’usage
1m60 buckets1440 bucketsSurveillance en temps réel
1h24 buckets168 bucketsModèles quotidiens
1d7 buckets31 bucketsRapports hebdomadaires/mensuels

API de coût

Récupérez les répartitions de coûts au niveau du service en USD avec le point de terminaison /v1/organizations/cost_report.

Concepts clés

  • Devise : Tous les coûts en USD, rapportés sous forme de chaînes décimales dans les plus petites unités (centimes)
  • Types de coûts : Suivez les coûts d’utilisation des jetons, de recherche web et d’exécution de code
  • Regroupement : Regroupez les coûts par espace de travail ou description pour des répartitions détaillées
  • Buckets de temps : Granularité quotidienne uniquement (1d)

Pour les détails complets des paramètres et les schémas de réponse, consultez la référence de l’API de coût.

Les coûts du niveau de priorité utilisent un modèle de facturation différent et ne sont pas inclus dans le point de terminaison de coût. Suivez l’utilisation du niveau de priorité via le point de terminaison d’utilisation à la place.

Exemple de base

curl "https://api.anthropic.com/v1/organizations/cost_report?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-31T00:00:00Z&\
group_by[]=workspace_id&\
group_by[]=description" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

Pagination

Les deux points de terminaison prennent en charge la pagination pour les grands ensembles de données :

  1. Effectuez votre demande initiale
  2. Si has_more est true, utilisez la valeur next_page dans votre prochaine demande
  3. Continuez jusqu’à ce que has_more soit false
# Première demande
curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-31T00:00:00Z&\
limit=7" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

# La réponse inclut : "has_more": true, "next_page": "page_xyz..."

# Demande suivante avec pagination
curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-31T00:00:00Z&\
limit=7&\
page=page_xyz..." \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

Cas d’usage courants

Explorez des implémentations détaillées dans anthropic-cookbook :

  • Rapports d’utilisation quotidiens : Suivez les tendances de consommation de jetons
  • Attribution des coûts : Allouez les dépenses par espace de travail pour les refacturations
  • Efficacité du cache : Mesurez et optimisez la mise en cache des invites
  • Surveillance du budget : Configurez des alertes pour les seuils de dépenses
  • Export CSV : Générez des rapports pour les équipes financières

Questions fréquemment posées

À quel point les données sont-elles fraîches ?

Les données d’utilisation et de coût apparaissent généralement dans les 5 minutes suivant la completion de la demande API, bien que les délais puissent parfois être plus longs.

Quelle est la fréquence de polling recommandée ?

L’API prend en charge le polling une fois par minute pour une utilisation soutenue. Pour de courtes rafales (par exemple, télécharger des données paginées), un polling plus fréquent est acceptable. Mettez en cache les résultats pour les tableaux de bord qui nécessitent des mises à jour fréquentes.

Comment puis-je suivre l’utilisation de l’exécution de code ?

Les coûts d’exécution de code apparaissent dans le point de terminaison de coût regroupés sous Code Execution Usage dans le champ description. L’exécution de code n’est pas incluse dans le point de terminaison d’utilisation.

Comment puis-je suivre l’utilisation du niveau de priorité ?

Filtrez ou regroupez par service_tier dans le point de terminaison d’utilisation et recherchez la valeur priority. Les coûts du niveau de priorité ne sont pas disponibles dans le point de terminaison de coût.

Que se passe-t-il avec l’utilisation de Workbench ?

L’utilisation de l’API depuis Workbench n’est pas associée à une clé API, donc api_key_id sera null même lors du regroupement par cette dimension.

Comment l’espace de travail par défaut est-il représenté ?

L’utilisation et les coûts attribués à l’espace de travail par défaut ont une valeur null pour workspace_id.

Voir aussi

Les API d’utilisation et de coût peuvent être utilisées pour vous aider à offrir une meilleure expérience à vos utilisateurs, vous aider à gérer les coûts et préserver votre limite de taux. Apprenez-en plus sur certaines de ces autres fonctionnalités :