Aperçu de l'API
Comprenez les endpoints 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 aux plateformes cloud.
L'API Claude est une API RESTful à l'adresse https://api.anthropic.com qui fournit un accès programmatique aux modèles Claude et aux Claude Managed Agents.
Prérequis
Pour utiliser l'API Claude, vous aurez besoin de :
- Un compte Claude Console
- Une clé API, ou une règle Workload Identity Federation configurée
Pour des instructions de configuration étape par étape, consultez Démarrer.
API disponibles
L'API Claude comprend les API suivantes :
- Messages API : Envoyez des messages à Claude pour des interactions conversationnelles (
POST /v1/messages) - Message Batches API : 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) - Token Counting API : Comptez les tokens dans un message avant l'envoi pour gérer les coûts et les limites de débit (
POST /v1/messages/count_tokens) - Models API : Listez les modèles Claude disponibles et leurs détails (
GET /v1/models) - Files API : Téléchargez et gérez des fichiers à utiliser dans plusieurs appels API (
POST /v1/files,GET /v1/files) - Skills API : Créez et gérez des compétences d'agent personnalisées (
POST /v1/skills,GET /v1/skills)
Les API suivantes sont en bêta :
- Agents API : Définissez des configurations d'agent réutilisables et versionnées pour les Claude Managed Agents (
POST /v1/agents,GET /v1/agents) - Sessions API : Exécutez des sessions d'agent avec état dans des sandboxes cloud gérés (
POST /v1/sessions,GET /v1/sessions/{id}/events/stream) - Environments API : Configurez des modèles de sandbox pour les sessions d'agent (
POST /v1/environments,GET /v1/environments)
Pour la référence API complète avec tous les endpoints, paramètres et schémas de réponse, explorez les pages de référence API listées dans la navigation. Pour accéder aux fonctionnalités bêta, consultez Beta headers.
Authentification
Pour plus de détails sur chaque méthode d'authentification et quand l'utiliser, consultez Authentification. Les requêtes vers l'API Claude incluent ces en-têtes :
| En-tête | Valeur | Obligatoire |
|---|---|---|
Authorization | Bearer <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 Federation | Oui, sauf si x-api-key est défini |
x-api-key | Votre clé API provenant de la Console. Solution de repli historique pour Authorization, toujours prise en charge | Non |
anthropic-workspace-id | ID du workspace dans lequel la requête s'exécute (par exemple, wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ). Consultez Sélectionner un espace de travail. | Obligatoire avec une clé API multi-workspace. Facultatif pour les autres clés API. Une clé créée pour un seul workspace s'exécute dans ce workspace lorsque vous omettez l'en-tête. Non utilisé avec les jetons Workload Identity Federation, qui sélectionnent un workspace lors de l'échange de jetons. |
anthropic-version | Version de l'API (par exemple, 2023-06-01) | Oui |
content-type | application/json | Oui |
Si vous utilisez les SDK clients, le SDK envoie automatiquement les en-têtes d'authentification, de version et de content-type ; vous transmettez vous-même anthropic-workspace-id lorsque votre clé en a besoin. Pour plus de détails sur le versionnage de l'API, consultez Versions de l'API.
Lors de l'accès à Claude via une plateforme cloud, l'authentification est intégrée au système IAM du fournisseur cloud. Consultez la documentation spécifique à la 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 (consultez Obtenir votre clé API Claude). Vous choisissez le type de chaque clé (consultez Types de clés) et son expiration lors de sa création. Utilisez les workspaces 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) - Gestion des requêtes et réponses avec typage sûr
- 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 les plateformes cloud. Choisissez en fonction de votre infrastructure, de la disponibilité des fonctionnalités, des 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 : Nouvelles intégrations, accès complet aux fonctionnalités, relation directe avec Anthropic
API des plateformes cloud
Accédez à Claude via AWS, Google Cloud ou Microsoft Azure :
- Intégré à la facturation et à l'IAM du fournisseur cloud
- La disponibilité des fonctionnalités varie selon la plateforme : Les plateformes exploitées par Anthropic incluent Claude Platform on AWS et Microsoft Foundry ; les plateformes exploitées par des partenaires incluent 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 : Engagements cloud existants, exigences de conformité spécifiques, facturation cloud consolidée
| Plateforme | Fournisseur | Documentation |
|---|---|---|
| Agent Platform | Google Cloud | Claude sur Google Cloud |
| Amazon Bedrock | AWS | Claude dans Amazon Bedrock |
| Claude Platform on AWS | AWS (exploité par Anthropic) | Claude Platform on AWS |
| Microsoft Foundry | Microsoft Azure (exploité par Anthropic) | Claude dans Microsoft Foundry |
Format des requêtes et réponses
Limites de taille des requêtes
| Endpoint | Taille maximale de requête |
|---|---|
| Messages, Token Counting | 32 Mo |
| Message Batches API | 256 Mo |
| Files API | 500 Mo |
| Sessions, Agents, Environments | 32 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ête | Description |
|---|---|
request-id | Un identifiant globalement unique pour la requête, tel que req_018EeWyXxfu5pfWkrYcMdjWG. Incluez-le lorsque vous contactez le support à propos d'une requête spécifique. Consultez Request ID. |
anthropic-organization-id | L'ID de l'organisation à laquelle appartient la clé API ou le jeton d'accès utilisé dans la requête. |
anthropic-workspace-id | L'ID préfixé par wrkspc_ du workspace auquel la clé API ou le jeton d'accès a été résolu, tel que wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ, y compris lorsqu'il s'agit du Workspace par défaut de votre organisation. Absent lorsque l'identifiant ne se résout pas à un workspace (par exemple, sur les requêtes Admin API) ou que la requête échoue avant la fin de l'authentification. Consultez Identifier le workspace 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 le workspace derrière une réponse API.
Pagination
Les endpoints de liste renvoient les résultats par pages. La plupart des endpoints de liste plus 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 à côté des champs de curseur pour naviguer entre les pages.
| Nom | Emplacement | Description |
|---|---|---|
limit | Paramètre de requête | Nombre maximal d'éléments à renvoyer par page. |
page | Paramètre de requête | Curseur opaque d'une réponse précédente. Transmettez ici une valeur next_page ou prev_page pour récupérer la page adjacente. |
order | Paramètre de requête | Direction de tri pour les résultats (asc ou desc), sur les endpoints 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_page | Champ de réponse | Curseur pour la page suivante, ou null s'il n'y a plus de résultats. |
prev_page | Champ de réponse | Curseur pour la page précédente sur les endpoints qui prennent en charge la pagination vers l'arrière (actuellement GET /v1/sessions), ou null si vous êtes sur la première page. Les autres endpoints de liste omettent ce champ. |
Pour revenir à une page précédente, transmettez prev_page comme paramètre page. prev_page est null lorsque vous êtes sur la première page. Tous les endpoints de liste ne prennent pas en charge prev_page. Seul GET /v1/sessions renvoie prev_page ; sur les endpoints de liste qui ne prennent pas en charge la pagination vers l'arrière, le champ est absent de la réponse plutôt que null. Pour un guide détaillé des requêtes, consultez Lister les sessions.
Le SDK fournit un itérateur à pagination automatique qui suit next_page pour vous. Par exemple, for session in client.beta.sessions.list() parcourt chaque session. La pagination automatique du SDK fonctionne uniquement vers l'avant ; pour revenir à la page précédente, lisez prev_page dans la réponse et retransmettez-le vous-même comme paramètre page. Consultez SDK clients pour plus de détails.
Limites de débit et disponibilité
Limites de débit
L'API applique des limites de débit et des limites de dépenses pour prévenir les abus et gérer la capacité. Les limites sont organisées en paliers d'utilisation ; votre organisation est placée automatiquement sur un palier et peut passer à un palier supérieur au fil du temps. Chaque palier 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 mensuelles plus élevé, utilisez Request tier increase sur la page Limites de débit.
Pour des informations détaillées sur les limites, les paliers et l'algorithme du seau à jetons 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 localisation.
Prochaines étapes
Spécification API complète pour les interactions directes avec les modèles
Endpoints Agents, Sessions et Environments
Python, TypeScript, C#, Go, Java, PHP et Ruby
Paliers d'utilisation, demande de limites plus élevées et algorithme du seau à jetons
Was this page helpful?