Claude Platform Docs

Bêta

Models
AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 47 more
One of the following:
BetaAPIError object{ type: "api_error", message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
BetaAuthenticationError object{ type: "authentication_error", message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
BetaBillingError object{ type: "billing_error", message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more
One of the following:
BetaErrorResponse object{ type: "error", error, request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string or null
BetaGatewayTimeoutError object{ type: "timeout_error", message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
BetaInvalidRequestError object{ type: "invalid_request_error", message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
BetaMonetaryAmount object{ amount, currency }

A monetary amount in a specific currency.

amount: string

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

currency: BetaCurrency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

BetaNotFoundError object{ type: "not_found_error", message }
type: "not_found_error"
defaultnot_found_error
message: string
defaultNot found
BetaOverloadedError object{ type: "overloaded_error", message }
type: "overloaded_error"
defaultoverloaded_error
message: string
defaultOverloaded
BetaPermissionError object{ type: "permission_error", message }
type: "permission_error"
defaultpermission_error
message: string
defaultPermission denied
BetaRateLimitError object{ type: "rate_limit_error", message }
type: "rate_limit_error"
defaultrate_limit_error
message: string
defaultRate limited

BêtaModèles

Lister les modèles
GET/v1/models

Lister les modèles disponibles.

Obtenir un modèle
GET/v1/models/{model_id}

Obtenir un modèle spécifique.

BêtaMessages

Créer un message
POST/v1/messages

Envoyez une liste structurée de messages d'entrée contenant du texte et/ou des images, et le modèle générera le message suivant de la conversation.

Compter les tokens d'un message
POST/v1/messages/count_tokens

Compter le nombre de tokens dans un message.

BêtaMessagesLots

Créer un lot de messages
POST/v1/messages/batches

Envoyez un lot de requêtes de création de messages.

Récupérer un lot de messages
GET/v1/messages/batches/{message_batch_id}

Ce point de terminaison est idempotent et peut être utilisé pour interroger l'état d'achèvement d'un lot de messages. Pour accéder aux résultats d'un lot de messages, effectuez une requête vers l'URL indiquée dans le champ results_url de la réponse.

Lister les lots de messages
GET/v1/messages/batches

Lister tous les lots de messages d'un espace de travail. Les lots créés le plus récemment sont renvoyés en premier.

Annuler un lot de messages
POST/v1/messages/batches/{message_batch_id}/cancel

Les lots peuvent être annulés à tout moment avant la fin du traitement. Une fois l'annulation lancée, le lot passe à l'état canceling, pendant lequel le système peut terminer les requêtes en cours non interruptibles avant de finaliser l'annulation.

Supprimer un lot de messages
DELETE/v1/messages/batches/{message_batch_id}
Récupérer les résultats d'un lot de messages
GET/v1/messages/batches/{message_batch_id}/results

Diffuse en streaming les résultats d'un lot de messages sous forme de fichier .jsonl.

BêtaAgents

Créer un agent
POST/v1/agents
Lister les agents
GET/v1/agents
Obtenir un agent
GET/v1/agents/{agent_id}
Mettre à jour un agent
POST/v1/agents/{agent_id}
Archiver un agent
POST/v1/agents/{agent_id}/archive

BêtaAgentsVersions

Lister les versions d'un agent
GET/v1/agents/{agent_id}/versions

BêtaEnvironnements

Créer un environnement
POST/v1/environments

Créer un nouvel environnement avec la configuration spécifiée.

Lister les environnements
GET/v1/environments

Lister les environnements avec prise en charge de la pagination.

Obtenir un environnement
GET/v1/environments/{environment_id}

Récupérer un environnement spécifique par son identifiant.

Mettre à jour un environnement
POST/v1/environments/{environment_id}

Mettre à jour la configuration d'un environnement existant.

Supprimer un environnement
DELETE/v1/environments/{environment_id}

Supprimer un environnement par son identifiant. Renvoie une confirmation de la suppression.

Archiver un environnement
POST/v1/environments/{environment_id}/archive

Archiver un environnement par son identifiant. Les environnements archivés ne peuvent pas être utilisés pour créer de nouvelles sessions.

BêtaEnvironnementsTravail

Obtenir un élément de travail
GET/v1/environments/{environment_id}/work/{work_id}

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Interroger pour obtenir du travail
GET/v1/environments/{environment_id}/work/poll

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Accuser réception d'un travail
POST/v1/environments/{environment_id}/work/{work_id}/ack

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Enregistrer un signal de présence
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Arrêter un travail
POST/v1/environments/{environment_id}/work/{work_id}/stop

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Lister les éléments de travail
GET/v1/environments/{environment_id}/work

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Mettre à jour un élément de travail
POST/v1/environments/{environment_id}/work/{work_id}

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Obtenir les statistiques de la file d'attente
GET/v1/environments/{environment_id}/work/stats

Obtenir des statistiques sur la file d'attente de travail d'un environnement.

BêtaSessions

Créer une session
POST/v1/sessions
Lister les sessions
GET/v1/sessions
Obtenir une session
GET/v1/sessions/{session_id}
Mettre à jour une session
POST/v1/sessions/{session_id}
Supprimer une session
DELETE/v1/sessions/{session_id}
Archiver une session
POST/v1/sessions/{session_id}/archive

BêtaSessionsÉvénements

Lister les événements
GET/v1/sessions/{session_id}/events
Envoyer des événements
POST/v1/sessions/{session_id}/events
Diffuser les événements en streaming
GET/v1/sessions/{session_id}/events/stream

BêtaSessionsRessources

Ajouter une ressource de session
POST/v1/sessions/{session_id}/resources
Lister les ressources de session
GET/v1/sessions/{session_id}/resources
Obtenir une ressource de session
GET/v1/sessions/{session_id}/resources/{resource_id}
Mettre à jour une ressource de session
POST/v1/sessions/{session_id}/resources/{resource_id}
Supprimer une ressource de session
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BêtaSessionsFils

Lister les fils de session
GET/v1/sessions/{session_id}/threads
Obtenir un fil de session
GET/v1/sessions/{session_id}/threads/{thread_id}
Archiver un fil de session
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BêtaSessionsFilsÉvénements

Lister les événements d'un fil de session
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Diffuser en streaming les événements d'un fil de session
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BêtaDéploiements

Créer un déploiement
POST/v1/deployments
Lister les déploiements
GET/v1/deployments
Obtenir un déploiement
GET/v1/deployments/{deployment_id}
Mettre à jour un déploiement
POST/v1/deployments/{deployment_id}
Archiver un déploiement
POST/v1/deployments/{deployment_id}/archive
Exécuter un déploiement maintenant
POST/v1/deployments/{deployment_id}/run
Mettre en pause un déploiement
POST/v1/deployments/{deployment_id}/pause
Reprendre un déploiement
POST/v1/deployments/{deployment_id}/unpause

BêtaExécutions de déploiement

Lister les exécutions de déploiement
GET/v1/deployment_runs
Obtenir une exécution de déploiement
GET/v1/deployment_runs/{deployment_run_id}

BêtaCoffres-forts

Créer un coffre-fort
POST/v1/vaults
Lister les coffres-forts
GET/v1/vaults
Obtenir un coffre-fort
GET/v1/vaults/{vault_id}
Mettre à jour un coffre-fort
POST/v1/vaults/{vault_id}
Supprimer un coffre-fort
DELETE/v1/vaults/{vault_id}
Archiver un coffre-fort
POST/v1/vaults/{vault_id}/archive

BêtaCoffres-fortsIdentifiants

Créer un identifiant
POST/v1/vaults/{vault_id}/credentials
Lister les identifiants
GET/v1/vaults/{vault_id}/credentials
Obtenir un identifiant
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Mettre à jour un identifiant
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Supprimer un identifiant
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archiver un identifiant
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Valider un identifiant
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BêtaMagasins de mémoire

Créer un magasin de mémoire
POST/v1/memory_stores
Lister les magasins de mémoire
GET/v1/memory_stores
Récupérer un magasin de mémoire
GET/v1/memory_stores/{memory_store_id}
Mettre à jour un magasin de mémoire
POST/v1/memory_stores/{memory_store_id}
Supprimer un magasin de mémoire
DELETE/v1/memory_stores/{memory_store_id}
Archiver un magasin de mémoire
POST/v1/memory_stores/{memory_store_id}/archive

BêtaMagasins de mémoireMémoires

Créer une mémoire
POST/v1/memory_stores/{memory_store_id}/memories
Lister les mémoires
GET/v1/memory_stores/{memory_store_id}/memories
Récupérer une mémoire
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Mettre à jour une mémoire
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Supprimer une mémoire
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BêtaMagasins de mémoireVersions de mémoire

Lister les versions de mémoire
GET/v1/memory_stores/{memory_store_id}/memory_versions
Récupérer une version de mémoire
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Expurger une version de mémoire
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BêtaFichiers

Téléverser un fichier
POST/v1/files
Lister les fichiers
GET/v1/files
Télécharger un fichier
GET/v1/files/{file_id}/content
Obtenir les métadonnées d'un fichier
GET/v1/files/{file_id}
Supprimer un fichier
DELETE/v1/files/{file_id}

BêtaCompétences

Créer un Skill
POST/v1/skills
Lister les Skills
GET/v1/skills
Obtenir un Skill
GET/v1/skills/{skill_id}
Supprimer un Skill
DELETE/v1/skills/{skill_id}

BêtaCompétencesVersions

Créer une version de Skill
POST/v1/skills/{skill_id}/versions
Lister les versions de Skill
GET/v1/skills/{skill_id}/versions
Télécharger le contenu d'une version de skill
GET/v1/skills/{skill_id}/versions/{version}/content

Télécharge le contenu d'une version de skill sous forme d'archive zip.

Obtenir une version de Skill
GET/v1/skills/{skill_id}/versions/{version}
Supprimer une version de Skill
DELETE/v1/skills/{skill_id}/versions/{version}

BêtaProfils utilisateur

Créer un profil utilisateur
POST/v1/user_profiles
Lister les profils utilisateur
GET/v1/user_profiles
Obtenir un profil utilisateur
GET/v1/user_profiles/{user_profile_id}
Mettre à jour un profil utilisateur
POST/v1/user_profiles/{user_profile_id}
Créer une URL d'inscription
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BêtaRêves

Créer un Dream
POST/v1/dreams

Démarrez une tâche asynchrone qui utilise des sessions passées pour produire une version réorganisée d'un magasin de mémoire, et récupérez le rêve à interroger pour obtenir le résultat.

Lister les Dreams
GET/v1/dreams

Listez les rêves de l'espace de travail, du plus récent au plus ancien.

Obtenir un Dream
GET/v1/dreams/{dream_id}

Obtenez un rêve par son ID pour vérifier son statut, son magasin de mémoire de sortie et son utilisation de tokens.

Annuler un Dream
POST/v1/dreams/{dream_id}/cancel

Arrêtez un rêve pending ou running.

Archiver un Dream
POST/v1/dreams/{dream_id}/archive

Masquez un rêve completed, failed ou canceled de la liste par défaut des rêves.

BêtaTunnels

Créer un tunnel
POST/v1/tunnels

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Obtenir un tunnel
GET/v1/tunnels/{tunnel_id}

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Lister les tunnels
GET/v1/tunnels

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Archiver un tunnel
POST/v1/tunnels/{tunnel_id}/archive

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Révéler le jeton d'un tunnel
POST/v1/tunnels/{tunnel_id}/reveal_token

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Effectuer la rotation du jeton d'un tunnel
POST/v1/tunnels/{tunnel_id}/rotate_token

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

BêtaTunnelsCertificats

Créer un certificat de tunnel
POST/v1/tunnels/{tunnel_id}/certificates

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Obtenir un certificat de tunnel
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Lister les certificats de tunnel
GET/v1/tunnels/{tunnel_id}/certificates

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Archiver un certificat de tunnel
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

BêtaOrganisation

Obtenir l'organisation actuelle
GET/v1/organizations/me

Récupérer les informations sur l'organisation associée à la clé API authentifiée.

BêtaOrganisationClés API

Lister les clés API
GET/v1/organizations/api_keys
Récupérer une clé API (API Admin)
GET/v1/organizations/api_keys/{api_key_id}

Récupérer les informations sur une clé API unique de votre organisation, recherchée par son ID. Ce point de terminaison de l'API Admin nécessite une clé API Admin, est destiné à la gestion programmatique des clés et ne renvoie jamais la valeur secrète de la clé. Pour consulter ou créer vos propres clés API, accédez à Clés API dans la Claude Console.

Mettre à jour une clé API
POST/v1/organizations/api_keys/{api_key_id}

BêtaOrganisationClés externes

Créer une clé externe
POST/v1/organizations/external_keys

Créer une configuration de clé externe appartenant à l'organisation de l'appelant.

Lister les clés externes
GET/v1/organizations/external_keys

Listez les configurations de clés externes de l'organisation de l'appelant.

Obtenir une clé externe
GET/v1/organizations/external_keys/{external_key_id}

Récupérer par son ID une configuration de clé externe unique de l'organisation de l'appelant.

Mettre à jour une clé externe
POST/v1/organizations/external_keys/{external_key_id}

Mettez à jour partiellement une configuration de clé externe. Les champs omis restent inchangés.

Supprimer une clé externe
DELETE/v1/organizations/external_keys/{external_key_id}

Supprimer une configuration de clé externe.

Valider une clé externe
POST/v1/organizations/external_keys/{external_key_id}/validate

Validez une configuration de clé externe auprès du KMS du client.

BêtaOrganisationFédérationÉmetteurs

Créer un émetteur de fédération
POST/v1/organizations/federation_issuers

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les émetteurs de fédération
GET/v1/organizations/federation_issuers

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir un émetteur de fédération
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour un émetteur de fédération
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Archiver un émetteur de fédération
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

BêtaOrganisationFédérationRègles

Créer une règle de fédération
POST/v1/organizations/federation_rules

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les règles de fédération
GET/v1/organizations/federation_rules

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir une règle de fédération
GET/v1/organizations/federation_rules/{federation_rule_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour une règle de fédération
POST/v1/organizations/federation_rules/{federation_rule_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Archiver une règle de fédération
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

BêtaOrganisationFédérationRèglesEspaces de travail

Ajouter un espace de travail à une règle de fédération
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les espaces de travail d'une règle de fédération
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Retirer un espace de travail d'une règle de fédération
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

BêtaOrganisationInvitations

Créer une invitation
POST/v1/organizations/invites

Invitez un utilisateur à rejoindre l'organisation par e-mail.

Lister les invitations
GET/v1/organizations/invites

Listez les invitations de l'organisation.

Obtenir une invitation
GET/v1/organizations/invites/{invite_id}

Récupérez une invitation par son ID.

Supprimer une invitation
DELETE/v1/organizations/invites/{invite_id}

Supprimez une invitation en attente.

BêtaOrganisationComptes de service

Créer un compte de service
POST/v1/organizations/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les comptes de service
GET/v1/organizations/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir un compte de service
GET/v1/organizations/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour un compte de service
POST/v1/organizations/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Archiver un compte de service
POST/v1/organizations/service_accounts/{service_account_id}/archive

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

BêtaOrganisationComptes de serviceEspaces de travail

Ajouter un espace de travail à un compte de service
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les espaces de travail d'un compte de service
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Retirer un espace de travail d'un compte de service
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

BêtaOrganisationUtilisateurs

Lister les utilisateurs
GET/v1/organizations/users

Listez les membres de l'organisation.

Obtenir un utilisateur
GET/v1/organizations/users/{user_id}

Récupérez un membre de l'organisation par son ID utilisateur.

Mettre à jour un utilisateur
POST/v1/organizations/users/{user_id}

Mettez à jour le rôle d'un membre dans l'organisation.

Retirer un utilisateur
DELETE/v1/organizations/users/{user_id}

Retirez un membre de l'organisation.

BêtaOrganisationEspaces de travail

Lister les espaces de travail
GET/v1/organizations/workspaces
Créer un espace de travail
POST/v1/organizations/workspaces
Obtenir un espace de travail
GET/v1/organizations/workspaces/{workspace_id}
Mettre à jour un espace de travail
POST/v1/organizations/workspaces/{workspace_id}
Archiver un espace de travail
POST/v1/organizations/workspaces/{workspace_id}/archive

BêtaOrganisationEspaces de travailLimites de débit

Lister les limites de débit d'un espace de travail
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste les rate limits (limites de débit) d'un espace de travail.

BêtaOrganisationEspaces de travailMembres

Lister les membres d'un espace de travail
GET/v1/organizations/workspaces/{workspace_id}/members
Créer un membre d'espace de travail
POST/v1/organizations/workspaces/{workspace_id}/members
Obtenir un membre d'espace de travail
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Mettre à jour un membre d'espace de travail
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Supprimer un membre d'espace de travail
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BêtaOrganisationEspaces de travailComptes de service

Lister les membres d'espace de travail de type compte de service
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Créer un membre d'espace de travail de type compte de service
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés API Admin ne sont pas acceptées. Consultez Gérer WIF avec l'API Admin.

Obtenir un membre d'espace de travail de type compte de service
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés API Admin ne sont pas acceptées. Consultez Gérer WIF avec l'API Admin.

Mettre à jour un membre d'espace de travail de type compte de service
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés API Admin ne sont pas acceptées. Consultez Gérer WIF avec l'API Admin.

Supprimer un membre d'espace de travail de type compte de service
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés API Admin ne sont pas acceptées. Consultez Gérer WIF avec l'API Admin.

BêtaOrganisationLimites de débit

Lister les limites de débit de l'organisation
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

BêtaOrganisationParamètres de conformité

Obtenir les paramètres de conformité
GET/v1/organizations/compliance_settings

Récupère les paramètres de conformité de votre organisation.

Mettre à jour les paramètres de conformité
POST/v1/organizations/compliance_settings

Met à jour les paramètres de conformité de votre organisation.

BêtaOrganisationRapport d'utilisation

Obtenir le rapport d'utilisation des messages
GET/v1/organizations/usage_report/messages
Obtenir le rapport d'utilisation de Claude Code
GET/v1/organizations/usage_report/claude_code

Récupérer les métriques d'utilisation quotidiennes agrégées pour les utilisateurs de Claude Code. Permet aux organisations d'analyser la productivité des développeurs et de créer des tableaux de bord personnalisés.

BêtaOrganisationRapport de coûts

Obtenir le rapport de coûts
GET/v1/organizations/cost_report

BêtaOrganisationTunnels MCP

Lister les tunnels
Deprecated
GET/v1/organizations/tunnels

Déprécié. Ce point de terminaison de l'Admin API est remplacé par /v1/tunnels sur la Claude API et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Obtenir un tunnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

Déprécié. Ce point de terminaison de l'API Admin est remplacé par /v1/tunnels sur l'API Claude et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Archiver un tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

Déprécié. Ce point de terminaison de l'API Admin est remplacé par /v1/tunnels sur l'API Claude et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Révéler le jeton d'un tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

Déprécié. Ce point de terminaison de l'Admin API est remplacé par /v1/tunnels sur la Claude API et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Effectuer la rotation du jeton d'un tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

Déprécié. Ce point de terminaison de l'Admin API est remplacé par /v1/tunnels sur la Claude API et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

BêtaOrganisationTunnels MCPCertificats de tunnel

Créer un certificat de tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

Déprécié. Ce point de terminaison de l'API Admin est remplacé par /v1/tunnels sur l'API Claude et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Lister les certificats de tunnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

Déprécié. Ce point de terminaison de l'Admin API est remplacé par /v1/tunnels sur la Claude API et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Obtenir un certificat de tunnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

Déprécié. Ce point de terminaison de l'API Admin est remplacé par /v1/tunnels sur l'API Claude et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

Archiver un certificat de tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Déprécié. Ce point de terminaison de l'Admin API est remplacé par /v1/tunnels sur l'API Claude et sera supprimé après une période de migration. Les nouvelles intégrations doivent utiliser /v1/tunnels avec l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et un jeton WIF portant la portée workspace:manage_tunnels. Les intégrations existantes continuent de fonctionner avec l'en-tête mcp-tunnels-2026-05-19 et la portée org:manage_tunnels pendant la période de migration.

BêtaOrganisationAnalytiqueSummaries

Obtenir les résumés d'activité
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

BêtaOrganisationAnalytiqueUtilisateurs

Lister l'activité des utilisateurs
GET/v1/organizations/analytics/users

Obtenir l'activité par utilisateur pour un jour donné, avec pagination par curseur.

BêtaOrganisationAnalytiqueApplicationsChatProjets

Obtenir l'utilisation des projets de chat
GET/v1/organizations/analytics/apps/chat/projects

Obtenir l'activité par projet pour un jour donné, avec pagination par curseur.

BêtaOrganisationAnalytiqueConnecteurs

Obtenir l'utilisation des connecteurs
GET/v1/organizations/analytics/connectors

Obtenir l'utilisation par connecteur pour un jour donné, avec pagination par curseur.

BêtaOrganisationAnalytiquePlugins

Obtenir l'utilisation des plugins
GET/v1/organizations/analytics/plugins

Obtenir l'utilisation par plugin (installations + invocations) pour un jour donné, avec pagination.

BêtaOrganisationAnalytiqueCompétences

Obtenir l'utilisation des skills
GET/v1/organizations/analytics/skills

Obtenir l'utilisation par skill pour un jour donné, avec pagination par curseur.

BêtaOrganisationAnalytiqueArtifacts

Obtenir l'activité des artifacts
GET/v1/organizations/analytics/artifacts

Obtenir l'activité de création d'artifacts pour un jour donné, ventilée par type MIME.

BêtaOrganisationAnalytiqueRapport d'utilisation

Obtenir l'utilisation de tokens au fil du temps
GET/v1/organizations/analytics/usage_report

Obtenir l'utilisation de tokens au fil du temps sur une plage de dates.

BêtaOrganisationAnalytiqueUser Usage Report

Obtenir l'utilisation de tokens par utilisateur
GET/v1/organizations/analytics/user_usage_report

Obtenir l'utilisation de tokens par utilisateur sur une plage de dates.

BêtaOrganisationAnalytiqueRapport de coûts

Obtenir le coût au fil du temps
GET/v1/organizations/analytics/cost_report

Obtenir le coût en USD au fil du temps sur une plage de dates.

BêtaOrganisationAnalytiqueUser Cost Report

Obtenir le coût par utilisateur
GET/v1/organizations/analytics/user_cost_report

Obtenir le coût par utilisateur en USD sur une plage de dates.

BêtaOrganisationLimites de dépenses

Définir une limite de dépenses
POST/v1/organizations/spend_limits

Définit une limite de dépenses.

Obtenir une limite de dépenses
GET/v1/organizations/spend_limits/{spend_limit_id}

Récupérer une limite de dépenses par son ID.

Supprimer une limite de dépenses
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Supprime une limite de dépenses.

List Spend Limits
GET/v1/organizations/spend_limits

List the organization's spend limits.

BêtaOrganisationLimites de dépensesEffective

Lister les limites de dépenses effectives
GET/v1/organizations/spend_limits/effective

Lister la limite de dépenses effective de chaque membre et ses dépenses cumulées sur la période.

BêtaOrganisationLimites de dépensesDemandes d'augmentation

Lister les demandes d'augmentation de limite de dépenses
GET/v1/organizations/spend_limit_increase_requests

Lister les demandes d'augmentation de limite de dépenses, les plus récentes en premier.

Obtenir une demande d'augmentation de limite de dépenses
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Récupérer une demande d'augmentation de limite de dépenses.

Approuver une demande d'augmentation de limite de dépenses
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Approuver une demande d'augmentation de limite de dépenses en attente.

Refuser une demande d'augmentation de limite de dépenses
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Refuser une demande d'augmentation de limite de dépenses en attente.

BêtaOrganisationGroupes RBAC

Créer un groupe RBAC
POST/v1/organizations/rbac_groups

Créer un groupe RBAC dans le tenant Claude Enterprise. Les groupes créés via l'API ont le type de source "direct".

Lister les groupes RBAC
GET/v1/organizations/rbac_groups

Lister les groupes RBAC du tenant Claude Enterprise.

Obtenir un groupe RBAC
GET/v1/organizations/rbac_groups/{rbac_group_id}

Récupérer un groupe RBAC par son ID.

Mettre à jour un groupe RBAC
POST/v1/organizations/rbac_groups/{rbac_group_id}

Met à jour le nom d'un groupe RBAC. Les groupes provisionnés par un fournisseur d'identité (type de source "scim") ne peuvent pas être modifiés via l'API tant qu'une organisation du locataire utilise le provisionnement SCIM.

Supprimer un groupe RBAC
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Supprime un groupe RBAC. Les groupes provisionnés par un fournisseur d'identité (type de source "scim") ne peuvent pas être supprimés via l'API tant qu'une organisation du locataire utilise le provisionnement SCIM.

BêtaOrganisationGroupes RBACMembres

Lister les membres d'un groupe RBAC
GET/v1/organizations/rbac_groups/{rbac_group_id}/members
Ajouter un membre à un groupe RBAC
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Ajoute un utilisateur à un groupe RBAC. L'appartenance aux groupes provisionnés par un fournisseur d'identité (type de source "scim") ne peut pas être modifiée via l'API tant qu'une organisation du locataire utilise le provisionnement SCIM.

Retirer un membre d'un groupe RBAC
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Retire un utilisateur d'un groupe RBAC. L'appartenance aux groupes provisionnés par un fournisseur d'identité (type de source "scim") ne peut pas être modifiée via l'API tant qu'une organisation du locataire utilise le provisionnement SCIM.

BêtaOrganisationRôles RBAC

Lister les rôles RBAC
GET/v1/organizations/rbac_roles

Lister les rôles RBAC de l'organisation.

Obtenir un rôle RBAC
GET/v1/organizations/rbac_roles/{rbac_role_id}

Récupérer un rôle RBAC par son ID.

BêtaOrganisationRôles RBACAutorisations

Lister les autorisations d'un rôle RBAC
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

Lister les autorisations accordées par un rôle RBAC.

BêtaOrganisationPlugins

Create Plugin
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

List Plugins
GET/v1/organizations/plugins

List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.

Delete Plugin
DELETE/v1/organizations/plugins/{plugin_id}

Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.

BêtaOrganisationPluginsVersions

Create Plugin Version
POST/v1/organizations/plugins/{plugin_id}/versions

Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.

List Plugin Versions
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download one version's .zip archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed.

BêtaOrganisationPluginsInstallation Settings

List Plugin Installation Settings
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

BêtaOrganisationPluginsShares

List Plugin Shares
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

BêtaOrganisationPlugin Marketplaces

List Plugin Marketplaces
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.

Validate Plugin Marketplace Repository
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.