Claude Platform Docs
Référence APIUtiliser l'API

Présentation de l'API

Comprenez les points de terminaison disponibles de l'API Claude, les en-têtes d'authentification, les SDK clients, la pagination, les limites de débit et les options d'accès via les plateformes cloud.

L'API Claude est une API RESTful disponible à l'adresse https://api.anthropic.com qui fournit un accès programmatique aux modèles Claude et à Claude Managed Agents.

Prérequis

Pour utiliser l'API Claude, vous aurez besoin :

Pour des instructions de configuration étape par étape, consultez Premiers pas.

API disponibles

L'API Claude comprend les API suivantes :

  • API Messages : envoyez des messages à Claude pour des interactions conversationnelles (POST /v1/messages)
  • API Message Batches : traitez de grands volumes de requêtes Messages de manière asynchrone avec une réduction de coût de 50 % (POST /v1/messages/batches)
  • API Token Counting : comptez les tokens d'un message avant l'envoi afin de gérer les coûts et les limites de débit (POST /v1/messages/count_tokens)
  • API Models : listez les modèles Claude disponibles et leurs détails (GET /v1/models)
  • API Files : téléversez et gérez des fichiers à utiliser dans plusieurs appels API (POST /v1/files, GET /v1/files)
  • API Skills : créez et gérez des compétences d'agent personnalisées (POST /v1/skills, GET /v1/skills)

Les API suivantes sont en version bêta :

  • API Agents : définissez des configurations d'agent réutilisables et versionnées pour Claude Managed Agents (POST /v1/agents, GET /v1/agents)
  • API Sessions : exécutez des sessions d'agent avec état dans des sandbox cloud gérées (POST /v1/sessions, GET /v1/sessions/{id}/events/stream)
  • API Environments : configurez des modèles de sandbox pour les sessions d'agent (POST /v1/environments, GET /v1/environments)

Pour la référence complète de l'API avec tous les points de terminaison, paramètres et schémas de réponse, explorez les pages de référence de l'API listées dans la navigation. Pour accéder aux fonctionnalités bêta, consultez En-têtes bêta.

Authentification

Pour plus de détails sur chaque méthode d'authentification et sur le moment où l'utiliser, consultez Authentification. Les requêtes adressées à l'API Claude incluent ces en-têtes :

En-têteValeurRequis
AuthorizationBearer <token>, où <token> est votre clé API ou un jeton d'accès de courte durée obtenu via POST /v1/oauth/token grâce à Workload Identity FederationOui, sauf si x-api-key est défini
x-api-keyVotre clé API provenant de la Console. Solution de repli héritée pour Authorization, toujours prise en chargeNon
anthropic-workspace-idID de l'espace de travail dans lequel la requête s'exécute (par exemple, wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ). Consultez Sélectionner un espace de travail.Requis avec une clé API multi-espaces de travail. Facultatif pour les autres clés API. Non utilisé avec les jetons Workload Identity Federation, qui sélectionnent un espace de travail lors de l'échange de jetons.
anthropic-versionVersion de l'API (par exemple, 2023-06-01)Oui
content-typeapplication/jsonOui

Si vous utilisez les SDK clients, le SDK envoie automatiquement les en-têtes d'authentification, de version et de type de contenu ; vous transmettez vous-même anthropic-workspace-id lorsque votre clé le nécessite. Pour plus de détails sur le versionnage de l'API, consultez Versions de l'API.

Lorsque vous accédez à Claude via une plateforme cloud, l'authentification est intégrée au système IAM du fournisseur cloud. Consultez la documentation spécifique à chaque plateforme pour connaître les types d'identifiants pris en charge, les en-têtes requis et les options d'authentification.

Obtenir des clés API

L'API est mise à disposition via la Console web. Vous pouvez utiliser le playground pour essayer l'API dans le navigateur, puis générer des clés API dans les Paramètres du compte (voir Obtenir votre clé API Claude). Vous choisissez le type de chaque clé (voir Types de clés) et son expiration lors de sa création. Utilisez les espaces de travail pour séparer les environnements et contrôler les dépenses par cas d'usage.

SDK clients

Anthropic fournit des SDK officiels qui simplifient l'intégration de l'API en gérant l'authentification, le formatage des requêtes, la gestion des erreurs, et plus encore.

Avantages :

  • Gestion automatique des en-têtes (authentification, anthropic-version, content-type)
  • Traitement des requêtes et des réponses avec sûreté de typage
  • Logique de nouvelle tentative et gestion des erreurs intégrées
  • Prise en charge du streaming
  • Délais d'expiration des requêtes et gestion des connexions

Pour une liste des SDK clients, consultez SDK clients.

API Claude vs plateformes cloud

Claude est disponible via l'API Claude directe et via des plateformes cloud. Choisissez en fonction de votre infrastructure, de la disponibilité des fonctionnalités, de vos exigences de conformité et de vos préférences tarifaires.

API Claude

  • Accès direct aux derniers modèles et fonctionnalités
  • Facturation et support Anthropic
  • Idéal pour : les nouvelles intégrations, l'accès complet aux fonctionnalités, une relation directe avec Anthropic

API des plateformes cloud

Accédez à Claude via AWS, Google Cloud ou Microsoft Azure :

  • Intégration avec la facturation et l'IAM du fournisseur cloud
  • La disponibilité des fonctionnalités varie selon la plateforme : les plateformes exploitées par Anthropic comprennent Claude Platform on AWS et Microsoft Foundry ; les plateformes exploitées par des partenaires comprennent Amazon Bedrock et Google Cloud. Consultez la page de chaque plateforme pour connaître la disponibilité et le calendrier des fonctionnalités.
  • Idéal pour : les engagements cloud existants, les exigences de conformité spécifiques, la facturation cloud consolidée
PlateformeFournisseurDocumentation
Agent PlatformGoogle CloudClaude sur Google Cloud
Amazon BedrockAWSClaude dans Amazon Bedrock
Claude Platform on AWSAWS (exploité par Anthropic)Claude Platform on AWS
Microsoft FoundryMicrosoft Azure (exploité par Anthropic)Claude dans Microsoft Foundry

Format des requêtes et des réponses

Limites de taille des requêtes

Point de terminaisonTaille maximale de requête
Messages, Token Counting32 Mo
API Message Batches256 Mo
API Files500 Mo
Sessions, Agents, Environments32 Mo

Si vous dépassez ces limites, vous recevrez une erreur 413 request_too_large.

En-têtes de réponse

L'API Claude inclut les en-têtes suivants dans ses réponses :

En-têteDescription
request-idUn identifiant globalement unique pour la requête, tel que req_018EeWyXxfu5pfWkrYcMdjWG. Incluez-le lorsque vous contactez le support au sujet d'une requête spécifique. Consultez ID de requête.
anthropic-organization-idL'ID de l'organisation à laquelle appartient la clé API ou le jeton d'accès utilisé dans la requête.
anthropic-workspace-idL'ID préfixé par wrkspc_ de l'espace de travail auquel la clé API ou le jeton d'accès a été résolu, tel que wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ, y compris lorsqu'il s'agit de l'espace de travail par défaut de votre organisation. Absent lorsque l'identifiant ne se résout pas en un espace de travail (par exemple, pour les requêtes de l'API Admin) ou lorsque la requête échoue avant la fin de l'authentification. Consultez Identifier l'espace de travail derrière une réponse API.

Pour les en-têtes de limite de débit, consultez En-têtes de réponse dans Limites de débit. Pour des exemples qui lisent un en-tête de réponse par son nom avec chaque SDK, consultez Identifier l'espace de travail derrière une réponse API.

Pagination

Les points de terminaison de liste renvoient les résultats par pages. La plupart des points de terminaison de liste récents utilisent le schéma de curseur page et next_page décrit dans cette section. Certains utilisent un schéma différent ; consultez la note à la fin de cette section. Utilisez le paramètre de requête limit pour contrôler la taille de la page et le paramètre de requête page pour récupérer une page adjacente. Chaque réponse inclut un tableau data ainsi que des champs de curseur permettant de naviguer entre les pages.

NomEmplacementDescription
limitParamètre de requêteNombre maximal d'éléments à renvoyer par page.
pageParamètre de requêteCurseur opaque provenant d'une réponse précédente. Transmettez ici une valeur next_page ou prev_page pour récupérer la page adjacente.
orderParamètre de requêteSens de tri des résultats (asc ou desc), sur les points de terminaison de liste qui prennent en charge le tri. Un curseur page n'est valide qu'avec l'order avec lequel il a été créé.
next_pageChamp de réponseCurseur pour la page suivante, ou null s'il n'y a plus de résultats.
prev_pageChamp de réponseCurseur pour la page précédente sur les points de terminaison qui prennent en charge la pagination arrière (actuellement GET /v1/sessions), ou null si vous êtes sur la première page. Les autres points de terminaison de liste omettent ce champ.

Pour revenir à la page précédente, transmettez prev_page comme paramètre page. prev_page vaut null lorsque vous êtes sur la première page. Tous les points de terminaison de liste ne prennent pas en charge prev_page. Seul GET /v1/sessions renvoie prev_page ; sur les points de terminaison de liste qui ne prennent pas en charge la pagination arrière, le champ est absent de la réponse plutôt que null. Pour un exemple de requête détaillé, consultez Lister les sessions.

Chaque SDK fournit un itérateur à pagination automatique qui suit next_page pour vous. En Python et TypeScript, vous l'obtenez en itérant directement sur le résultat de la liste. Les autres SDK fournissent l'itérateur via une méthode distincte. La pagination automatique des SDK ne fonctionne que vers l'avant ; pour revenir à la page précédente, lisez prev_page dans la réponse et transmettez-le vous-même comme paramètre page. Consultez SDK clients pour les détails spécifiques à chaque langage.

Limites de débit et disponibilité

Limites de débit

L'API applique des « rate limits » (limites de débit) et des limites de dépenses afin de prévenir les abus et de gérer la capacité. Les limites sont organisées en niveaux d'utilisation ; votre organisation est placée automatiquement sur un niveau et peut passer à un niveau supérieur au fil du temps. Chaque niveau comporte :

  • Limites de dépenses : coût mensuel maximal pour l'utilisation de l'API
  • Limites de débit : nombre maximal de requêtes par minute (RPM) et de tokens par minute (TPM)

Vous pouvez consulter vos limites de débit sur la page Limites de débit et vos limites de dépenses sur la page Facturation de la Console. Pour obtenir des limites de débit plus élevées ou un plafond de dépenses mensuel plus élevé, utilisez Request rate limit increase sur la page Limites de débit.

Pour des informations détaillées sur les limites, les niveaux et l'algorithme de seau à jetons (token bucket) utilisé pour la limitation de débit, consultez Limites de débit.

Disponibilité

L'API Claude est disponible dans de nombreux pays et régions à travers le monde. Consultez la page des régions prises en charge pour confirmer la disponibilité dans votre zone géographique.

Prochaines étapes

Spécification complète de l'API pour les interactions directes avec les modèles

Points de terminaison Agents, Sessions et Environments

Python, TypeScript, C#, Go, Java, PHP et Ruby

Niveaux d'utilisation, demande de limites plus élevées et algorithme de seau à jetons

Was this page helpful?