Claude Platform Docs

Bêta

Models
type AnthropicBeta = (string & {}) | "message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 47 more
One of the following:
interface BetaAPIError { type: "api_error"; message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
interface BetaAuthenticationError { type: "authentication_error"; message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
interface BetaBillingError { type: "billing_error"; message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
type BetaCurrency = "USD"
type BetaError = BetaInvalidRequestError | BetaAuthenticationError | BetaBillingError | 6 more
One of the following:
interface BetaErrorResponse { type: "error"; error; request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string | null
interface BetaGatewayTimeoutError { type: "timeout_error"; message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
interface BetaInvalidRequestError { type: "invalid_request_error"; message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
interface BetaMonetaryAmount { 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.

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

BêtaModèles

Lister les modèles
client.beta.models.list(params?, options?): Page<BetaModelInfo>
GET/v1/models

Lister les modèles disponibles.

Obtenir un modèle
client.beta.models.retrieve(modelID, params?, options?): BetaModelInfo
GET/v1/models/{model_id}

Obtenir un modèle spécifique.

BêtaMessages

Créer un message
client.beta.messages.create(params, options?): BetaMessage | Stream<BetaRawMessageStreamEvent>
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
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount
POST/v1/messages/count_tokens

Compter le nombre de tokens dans un message.

BêtaMessagesLots

Créer un lot de messages
client.beta.messages.batches.create(params, options?): BetaMessageBatch
POST/v1/messages/batches

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

Récupérer un lot de messages
client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch
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
client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>
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
client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch
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
client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Récupérer les résultats d'un lot de messages
client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>
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
client.beta.agents.create(params, options?): BetaManagedAgentsAgent
POST/v1/agents
Lister les agents
client.beta.agents.list(params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents
Obtenir un agent
client.beta.agents.retrieve(agentID, params?, options?): BetaManagedAgentsAgent
GET/v1/agents/{agent_id}
Mettre à jour un agent
client.beta.agents.update(agentID, params, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}
Archiver un agent
client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}/archive

BêtaAgentsVersions

Lister les versions d'un agent
client.beta.agents.versions.list(agentID, params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents/{agent_id}/versions

BêtaEnvironnements

Créer un environnement
client.beta.environments.create(params, options?): BetaEnvironment
POST/v1/environments

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

Lister les environnements
client.beta.environments.list(params?, options?): PageCursor<BetaEnvironment>
GET/v1/environments

Lister les environnements avec prise en charge de la pagination.

Obtenir un environnement
client.beta.environments.retrieve(environmentID, params?, options?): BetaEnvironment
GET/v1/environments/{environment_id}

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

Mettre à jour un environnement
client.beta.environments.update(environmentID, params, options?): BetaEnvironment
POST/v1/environments/{environment_id}

Mettre à jour la configuration d'un environnement existant.

Supprimer un environnement
client.beta.environments.delete(environmentID, params?, options?): BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}

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

Archiver un environnement
client.beta.environments.archive(environmentID, params?, options?): BetaEnvironment
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
client.beta.environments.work.retrieve(workID, params, options?): BetaSelfHostedWork
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
client.beta.environments.work.poll(environmentID, params?, options?): BetaSelfHostedWork | null
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
client.beta.environments.work.ack(workID, params, options?): BetaSelfHostedWork
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
client.beta.environments.work.heartbeat(workID, params, options?): BetaSelfHostedWorkHeartbeatResponse
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
client.beta.environments.work.stop(workID, params, options?): BetaSelfHostedWork
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
client.beta.environments.work.list(environmentID, params?, options?): PageCursor<BetaSelfHostedWork>
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
client.beta.environments.work.update(workID, params, options?): BetaSelfHostedWork
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
client.beta.environments.work.stats(environmentID, params?, options?): BetaSelfHostedWorkQueueStats
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
client.beta.sessions.create(params, options?): BetaManagedAgentsSession
POST/v1/sessions
Lister les sessions
client.beta.sessions.list(params?, options?): BidirectionalPageCursor<BetaManagedAgentsSession>
GET/v1/sessions
Obtenir une session
client.beta.sessions.retrieve(sessionID, params?, options?): BetaManagedAgentsSession
GET/v1/sessions/{session_id}
Mettre à jour une session
client.beta.sessions.update(sessionID, params, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}
Supprimer une session
client.beta.sessions.delete(sessionID, params?, options?): BetaManagedAgentsDeletedSession
DELETE/v1/sessions/{session_id}
Archiver une session
client.beta.sessions.archive(sessionID, params?, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}/archive

BêtaSessionsÉvénements

Lister les événements
client.beta.sessions.events.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/events
Envoyer des événements
client.beta.sessions.events.send(sessionID, params, options?): BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
Diffuser les événements en streaming
client.beta.sessions.events.stream(sessionID, params?, options?): BetaManagedAgentsStreamSessionEvents | Stream<BetaManagedAgentsStreamSessionEvents>
GET/v1/sessions/{session_id}/events/stream

BêtaSessionsRessources

Ajouter une ressource de session
client.beta.sessions.resources.add(sessionID, params, options?): BetaManagedAgentsFileResource
POST/v1/sessions/{session_id}/resources
Lister les ressources de session
client.beta.sessions.resources.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionResource>
GET/v1/sessions/{session_id}/resources
Obtenir une ressource de session
client.beta.sessions.resources.retrieve(resourceID, params, options?): ResourceRetrieveResponse
GET/v1/sessions/{session_id}/resources/{resource_id}
Mettre à jour une ressource de session
client.beta.sessions.resources.update(resourceID, params, options?): ResourceUpdateResponse
POST/v1/sessions/{session_id}/resources/{resource_id}
Supprimer une ressource de session
client.beta.sessions.resources.delete(resourceID, params, options?): BetaManagedAgentsDeleteSessionResource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BêtaSessionsFils

Lister les fils de session
client.beta.sessions.threads.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionThread>
GET/v1/sessions/{session_id}/threads
Obtenir un fil de session
client.beta.sessions.threads.retrieve(threadID, params, options?): BetaManagedAgentsSessionThread
GET/v1/sessions/{session_id}/threads/{thread_id}
Archiver un fil de session
client.beta.sessions.threads.archive(threadID, params, options?): BetaManagedAgentsSessionThread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BêtaSessionsFilsÉvénements

Lister les événements d'un fil de session
client.beta.sessions.threads.events.list(threadID, params, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Diffuser en streaming les événements d'un fil de session
client.beta.sessions.threads.events.stream(threadID, params, options?): BetaManagedAgentsStreamSessionThreadEvents | Stream<BetaManagedAgentsStreamSessionThreadEvents>
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BêtaDéploiements

Créer un déploiement
client.beta.deployments.create(params, options?): BetaManagedAgentsDeployment
POST/v1/deployments
Lister les déploiements
client.beta.deployments.list(params?, options?): PageCursor<BetaManagedAgentsDeployment>
GET/v1/deployments
Obtenir un déploiement
client.beta.deployments.retrieve(deploymentID, params?, options?): BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
Mettre à jour un déploiement
client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
Archiver un déploiement
client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Exécuter un déploiement maintenant
client.beta.deployments.run(deploymentID, params?, options?): BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Mettre en pause un déploiement
client.beta.deployments.pause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Reprendre un déploiement
client.beta.deployments.unpause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause

BêtaExécutions de déploiement

Lister les exécutions de déploiement
client.beta.deploymentRuns.list(params?, options?): PageCursor<BetaManagedAgentsDeploymentRun>
GET/v1/deployment_runs
Obtenir une exécution de déploiement
client.beta.deploymentRuns.retrieve(deploymentRunID, params?, options?): BetaManagedAgentsDeploymentRun
GET/v1/deployment_runs/{deployment_run_id}

BêtaCoffres-forts

Créer un coffre-fort
client.beta.vaults.create(params, options?): BetaManagedAgentsVault
POST/v1/vaults
Lister les coffres-forts
client.beta.vaults.list(params?, options?): PageCursor<BetaManagedAgentsVault>
GET/v1/vaults
Obtenir un coffre-fort
client.beta.vaults.retrieve(vaultID, params?, options?): BetaManagedAgentsVault
GET/v1/vaults/{vault_id}
Mettre à jour un coffre-fort
client.beta.vaults.update(vaultID, params, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}
Supprimer un coffre-fort
client.beta.vaults.delete(vaultID, params?, options?): BetaManagedAgentsDeletedVault
DELETE/v1/vaults/{vault_id}
Archiver un coffre-fort
client.beta.vaults.archive(vaultID, params?, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}/archive

BêtaCoffres-fortsIdentifiants

Créer un identifiant
client.beta.vaults.credentials.create(vaultID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials
Lister les identifiants
client.beta.vaults.credentials.list(vaultID, params?, options?): PageCursor<BetaManagedAgentsCredential>
GET/v1/vaults/{vault_id}/credentials
Obtenir un identifiant
client.beta.vaults.credentials.retrieve(credentialID, params, options?): BetaManagedAgentsCredential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Mettre à jour un identifiant
client.beta.vaults.credentials.update(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Supprimer un identifiant
client.beta.vaults.credentials.delete(credentialID, params, options?): BetaManagedAgentsDeletedCredential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archiver un identifiant
client.beta.vaults.credentials.archive(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Valider un identifiant
client.beta.vaults.credentials.mcpOAuthValidate(credentialID, params, options?): BetaManagedAgentsCredentialValidation
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BêtaMagasins de mémoire

Créer un magasin de mémoire
client.beta.memoryStores.create(params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores
Lister les magasins de mémoire
client.beta.memoryStores.list(params?, options?): PageCursor<BetaManagedAgentsMemoryStore>
GET/v1/memory_stores
Récupérer un magasin de mémoire
client.beta.memoryStores.retrieve(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
GET/v1/memory_stores/{memory_store_id}
Mettre à jour un magasin de mémoire
client.beta.memoryStores.update(memoryStoreID, params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}
Supprimer un magasin de mémoire
client.beta.memoryStores.delete(memoryStoreID, params?, options?): BetaManagedAgentsDeletedMemoryStore
DELETE/v1/memory_stores/{memory_store_id}
Archiver un magasin de mémoire
client.beta.memoryStores.archive(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}/archive

BêtaMagasins de mémoireMémoires

Créer une mémoire
client.beta.memoryStores.memories.create(memoryStoreID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories
Lister les mémoires
client.beta.memoryStores.memories.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryListItem>
GET/v1/memory_stores/{memory_store_id}/memories
Récupérer une mémoire
client.beta.memoryStores.memories.retrieve(memoryID, params, options?): BetaManagedAgentsMemory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Mettre à jour une mémoire
client.beta.memoryStores.memories.update(memoryID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Supprimer une mémoire
client.beta.memoryStores.memories.delete(memoryID, params, options?): BetaManagedAgentsDeletedMemory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BêtaMagasins de mémoireVersions de mémoire

Lister les versions de mémoire
client.beta.memoryStores.memoryVersions.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryVersion>
GET/v1/memory_stores/{memory_store_id}/memory_versions
Récupérer une version de mémoire
client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Expurger une version de mémoire
client.beta.memoryStores.memoryVersions.redact(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BêtaFichiers

Téléverser un fichier
client.beta.files.upload(params, options?): BetaFileMetadata
POST/v1/files
Lister les fichiers
client.beta.files.list(params?, options?): PageCursor<BetaFileMetadata>
GET/v1/files
Télécharger un fichier
client.beta.files.download(fileID, params?, options?): Response
GET/v1/files/{file_id}/content
Obtenir les métadonnées d'un fichier
client.beta.files.retrieveMetadata(fileID, params?, options?): BetaFileMetadata
GET/v1/files/{file_id}
Supprimer un fichier
client.beta.files.delete(fileID, params?, options?): BetaDeletedFile
DELETE/v1/files/{file_id}

BêtaCompétences

Créer un Skill
client.beta.skills.create(params, options?): BetaSkill
POST/v1/skills
Lister les Skills
client.beta.skills.list(params?, options?): PageCursor<BetaSkill>
GET/v1/skills
Obtenir un Skill
client.beta.skills.retrieve(skillID, params?, options?): BetaSkill
GET/v1/skills/{skill_id}
Supprimer un Skill
client.beta.skills.delete(skillID, params?, options?): BetaDeletedSkill
DELETE/v1/skills/{skill_id}

BêtaCompétencesVersions

Créer une version de Skill
client.beta.skills.versions.create(skillID, params, options?): BetaSkillVersion
POST/v1/skills/{skill_id}/versions
Lister les versions de Skill
client.beta.skills.versions.list(skillID, params?, options?): PageCursor<BetaSkillVersion>
GET/v1/skills/{skill_id}/versions
Télécharger le contenu d'une version de skill
client.beta.skills.versions.download(version, params, options?): Response
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
client.beta.skills.versions.retrieve(version, params, options?): BetaSkillVersion
GET/v1/skills/{skill_id}/versions/{version}
Supprimer une version de Skill
client.beta.skills.versions.delete(version, params, options?): BetaDeletedSkillVersion
DELETE/v1/skills/{skill_id}/versions/{version}

BêtaProfils utilisateur

Créer un profil utilisateur
client.beta.userProfiles.create(params, options?): BetaUserProfile
POST/v1/user_profiles
Lister les profils utilisateur
client.beta.userProfiles.list(params?, options?): PageCursor<BetaUserProfile>
GET/v1/user_profiles
Obtenir un profil utilisateur
client.beta.userProfiles.retrieve(userProfileID, params?, options?): BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
Mettre à jour un profil utilisateur
client.beta.userProfiles.update(userProfileID, params, options?): BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
Créer une URL d'inscription
client.beta.userProfiles.createEnrollmentURL(userProfileID, params?, options?): BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BêtaRêves

Créer un Dream
client.beta.dreams.create(params, options?): BetaDream
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
client.beta.dreams.list(params?, options?): PageCursor<BetaDream>
GET/v1/dreams

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

Obtenir un Dream
client.beta.dreams.retrieve(dreamID, params?, options?): BetaDream
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
client.beta.dreams.cancel(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/cancel

Arrêtez un rêve pending ou running.

Archiver un Dream
client.beta.dreams.archive(dreamID, params?, options?): BetaDream
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
client.beta.tunnels.create(params, options?): BetaTunnel
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
client.beta.tunnels.retrieve(tunnelID, params?, options?): BetaTunnel
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
client.beta.tunnels.list(params?, options?): PageCursor<BetaTunnel>
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
client.beta.tunnels.archive(tunnelID, params?, options?): BetaTunnel
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
client.beta.tunnels.revealToken(tunnelID, params?, options?): BetaTunnelToken
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
client.beta.tunnels.rotateToken(tunnelID, params, options?): BetaTunnelToken
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
client.beta.tunnels.certificates.create(tunnelID, params, options?): BetaTunnelCertificate
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
client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificate
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
client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor<BetaTunnelCertificate>
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
client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificate
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
client.beta.organization.retrieve(options?): BetaOrganization
GET/v1/organizations/me

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

BêtaOrganisationClés API

Lister les clés API
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>
GET/v1/organizations/api_keys
Récupérer une clé API (Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}

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

Mettre à jour une clé API
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

BêtaOrganisationClés externes

Créer une clé externe
client.beta.organization.externalKeys.create(body, options?): BetaExternalKey
POST/v1/organizations/external_keys

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

Lister les clés externes
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys

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

Obtenir une clé externe
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}

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

Mettre à jour une clé externe
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey
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
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Supprimez une configuration de clé externe.

Valider une clé externe
client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
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
client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer
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 workload identity federation (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
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<BetaFederationIssuer>
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 workload identity federation (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
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer
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 workload identity federation (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
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer
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 workload identity federation (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
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer
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 workload identity federation (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
client.beta.organization.federation.rules.create(params, options?): BetaFederationRule
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 workload identity federation (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
client.beta.organization.federation.rules.list(params?, options?): PageCursor<BetaFederationRule>
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 workload identity federation (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
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule
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 workload identity federation (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
client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule
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 workload identity federation (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
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule
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 workload identity federation (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
client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): BetaFederationRuleWorkspace
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 workload identity federation (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
client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor<BetaFederationRuleWorkspace>
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 workload identity federation (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
client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
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 workload identity federation (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
client.beta.organization.invites.create(body, options?): BetaOrganizationInvite
POST/v1/organizations/invites

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

Lister les invitations
client.beta.organization.invites.list(query?, options?): Page<BetaOrganizationInvite>
GET/v1/organizations/invites

Listez les invitations de l'organisation.

Obtenir une invitation
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}

Récupérez une invitation par son ID.

Supprimer une invitation
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Supprimez une invitation en attente.

BêtaOrganisationComptes de service

Créer un compte de service
client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount
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 workload identity federation (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
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<BetaServiceAccount>
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 workload identity federation (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
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount
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 workload identity federation (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
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount
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 workload identity federation (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
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount
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 workload identity federation (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
client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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 workload identity federation (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
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
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 workload identity federation (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
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
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 workload identity federation (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
client.beta.organization.users.list(query?, options?): Page<BetaOrganizationUser>
GET/v1/organizations/users

Listez les membres de l'organisation.

Obtenir un utilisateur
client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUser
GET/v1/organizations/users/{user_id}

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

Mettre à jour un utilisateur
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}

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

Retirer un utilisateur
client.beta.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

Retirez un membre de l'organisation.

BêtaOrganisationEspaces de travail

Lister les espaces de travail
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>
GET/v1/organizations/workspaces
Créer un espace de travail
client.beta.organization.workspaces.create(params, options?): BetaWorkspace
POST/v1/organizations/workspaces
Obtenir un espace de travail
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Mettre à jour un espace de travail
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archiver un espace de travail
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspace
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
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Listez les « rate limits » (limites de débit) d'un espace de travail.

BêtaOrganisationEspaces de travailMembres

Lister les membres d'un espace de travail
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Créer un membre d'espace de travail
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Obtenir un membre d'espace de travail
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Mettre à jour un membre d'espace de travail
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Supprimer un membre d'espace de travail
client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BêtaOrganisationEspaces de travailComptes de service

Lister les comptes de service membres d'un espace de travail
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
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 workload identity federation (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 compte de service membre d'un espace de travail
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember
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 workload identity federation (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 membre d'un espace de travail
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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 workload identity federation (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 membre d'un espace de travail
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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 workload identity federation (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.

Supprimer un compte de service membre d'un espace de travail
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
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
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>
GET/v1/organizations/rate_limits

Liste les limites de débit de l'API Messages pour votre organisation.

BêtaOrganisationParamètres de conformité

Obtenir les paramètres de conformité
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettings
GET/v1/organizations/compliance_settings

Récupère les paramètres de conformité (Compliance Settings) de votre organisation.

Mettre à jour les paramètres de conformité
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettings
POST/v1/organizations/compliance_settings

Met à jour les paramètres de conformité (Compliance Settings) de votre organisation.

BêtaOrganisationAnalytiqueRésumés

Obtenir les résumés d'activité
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>
GET/v1/organizations/analytics/summaries

Obtient les résumés d'activité à l'échelle de l'organisation pour une plage de dates.

BêtaOrganisationAnalytiqueUtilisateurs

Lister l'activité des utilisateurs
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>
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
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>
GET/v1/organizations/analytics/apps/chat/projects

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

BêtaOrganisationAnalytiqueConnecteurs

Obtenir l'utilisation des connecteurs
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>
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
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>
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
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>
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
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>
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 des tokens au fil du temps
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>
GET/v1/organizations/analytics/usage_report

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

BêtaOrganisationAnalytiqueRapport d'utilisation par utilisateur

Obtenir l'utilisation des tokens par utilisateur
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>
GET/v1/organizations/analytics/user_usage_report

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

BêtaOrganisationAnalytiqueRapport de coûts

Obtenir les coûts au fil du temps
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>
GET/v1/organizations/analytics/cost_report

Obtient les coûts en USD au fil du temps sur une plage de dates.

BêtaOrganisationAnalytiqueRapport de coûts par utilisateur

Obtenir les coûts par utilisateur
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>
GET/v1/organizations/analytics/user_cost_report

Obtient les coûts par utilisateur en USD sur une plage de dates.

BêtaOrganisationLimites de dépenses

Définir une limite de dépenses
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimit
POST/v1/organizations/spend_limits

Définit une limite de dépenses.

Obtenir une limite de dépenses
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimit
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
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponse
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Supprime une limite de dépenses.

Lister les limites de dépenses
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>
GET/v1/organizations/spend_limits

Répertorie les limites de dépenses de l'organisation.

BêtaOrganisationLimites de dépensesEffectives

Lister les limites de dépenses effectives
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>
GET/v1/organizations/spend_limits/effective

Répertorie la limite de dépenses effective de chaque membre et ses dépenses depuis le début de la période.

BêtaOrganisationLimites de dépensesDemandes d'augmentation

Lister les demandes d'augmentation de limite de dépenses
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>
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
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequest
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
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponse
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
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequest
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
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroup
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
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>
GET/v1/organizations/rbac_groups

Lister les groupes RBAC du tenant Claude Enterprise.

Obtenir un groupe RBAC
client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): BetaRBACGroup
GET/v1/organizations/rbac_groups/{rbac_group_id}

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

Mettre à jour un groupe RBAC
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): BetaRBACGroup
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
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): RBACGroupDeleteResponse
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
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>
GET/v1/organizations/rbac_groups/{rbac_group_id}/members
Ajouter un membre à un groupe RBAC
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): BetaRBACGroupMember
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 tenant utilise le provisionnement SCIM.

Retirer un membre d'un groupe RBAC
client.beta.organization.rbacGroups.members.remove(userID, params, options?): MemberRemoveResponse
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 tenant utilise le provisionnement SCIM.

BêtaOrganisationRôles RBAC

Lister les rôles RBAC
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>
GET/v1/organizations/rbac_roles

Lister les rôles RBAC de l'organisation.

Obtenir un rôle RBAC
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRole
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
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

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

BêtaOrganisationPlugins

Créer un plugin
client.beta.organization.plugins.create(params, options?): BetaPlugin
POST/v1/organizations/plugins

Crée un plugin appartenant à l'organisation ainsi que sa première version en téléversant les fichiers de la version.

Obtenir un plugin
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPlugin
GET/v1/organizations/plugins/{plugin_id}

Récupère un plugin par son ID.

Mettre à jour un plugin
client.beta.organization.plugins.update(pluginID, params, options?): BetaPlugin
POST/v1/organizations/plugins/{plugin_id}

Modifiez la version stockée d'un Plugin appartenant à l'organisation qui est servie aux membres, par exemple pour revenir à une version antérieure. Cela épingle la version servie : les téléversements ultérieurs sont stockés mais ne modifient plus ce qui est servi, et l'épinglage ne peut actuellement pas être annulé, ni ici ni dans claude.ai.

Lister les Plugins
client.beta.organization.plugins.list(params?, options?): PageCursor<BetaPlugin>
GET/v1/organizations/plugins

Listez les Plugins créés au sein de l'organisation, du plus récent au plus ancien : ceux des marketplaces de plugins de l'organisation et ceux des marketplaces de plugins personnelles des membres.

Supprimer un Plugin
client.beta.organization.plugins.delete(pluginID, params?, options?): BetaDeletedPlugin
DELETE/v1/organizations/plugins/{plugin_id}

Supprimez définitivement un Plugin et toutes ses versions, exactement comme lorsqu'un administrateur le supprime dans claude.ai. Le Plugin peut appartenir à l'organisation ou à un membre, y compris un membre qui a depuis quitté l'organisation.

BêtaOrganisationPluginsVersions

Créer une version de Plugin
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion
POST/v1/organizations/plugins/{plugin_id}/versions

Ajoutez une version à un Plugin appartenant à l'organisation en téléversant les fichiers de la nouvelle version ; elle devient la version servie aux membres, sauf si la version servie du Plugin a été épinglée.

Lister les versions d'un Plugin
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>
GET/v1/organizations/plugins/{plugin_id}/versions

Listez les versions d'un Plugin, de la plus récente à la plus ancienne.

Obtenir une version de Plugin
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersion
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Récupérez une version d'un Plugin par son ID, ou la version la plus récente du Plugin.

Télécharger l'archive d'une version de Plugin
client.beta.organization.plugins.versions.download(version, params, options?): Response
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Téléchargez l'archive .zip d'une version, exactement telle qu'elle est stockée. Chaque téléchargement d'un Plugin provenant de la marketplace de plugins personnelle d'un membre est enregistré dans le flux d'activité de l'API Compliance.

BêtaOrganisationPluginsParamètres d'installation

Lister les paramètres d'installation d'un Plugin
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>
GET/v1/organizations/plugins/{plugin_id}/installation_settings

Listez les paramètres d'installation d'un Plugin appartenant à l'organisation, qui indiquent à quels membres il est destiné, du plus récemment créé au plus ancien.

Définir un paramètre d'installation de Plugin
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Définissez ou modifiez le paramètre d'installation d'un Plugin appartenant à l'organisation pour l'ensemble de l'organisation ou pour un groupe RBAC.

Supprimer un paramètre d'installation de Plugin
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Supprimez le paramètre d'installation propre à un Plugin appartenant à l'organisation pour l'ensemble de l'organisation ou pour un groupe RBAC.

BêtaOrganisationPluginsPartages

Lister les partages d'un Plugin
client.beta.organization.plugins.shares.list(pluginID, params?, options?): PageCursor<BetaPluginShare>
GET/v1/organizations/plugins/{plugin_id}/shares

Listez les partages accordés par le propriétaire d'un Plugin appartenant à un membre — à tous les membres de l'organisation, à un groupe RBAC ou à un seul membre —, du plus récemment accordé au plus ancien.

BêtaOrganisationMarketplaces de plugins

Lister les marketplaces de plugins
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>
GET/v1/organizations/plugin_marketplaces

Listez les marketplaces de plugins dans lesquelles se trouvent les Plugins, de la plus récente à la plus ancienne : celles de l'organisation et les marketplaces personnelles de ses membres.

Obtenir une marketplace de plugins
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Récupérez une marketplace de plugins par son ID.

Mettre à jour une marketplace de plugins
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): BetaPluginMarketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Définissez le paramètre d'installation par défaut de l'une des marketplaces de plugins de l'organisation. Chaque Plugin qu'elle contient et qui ne possède pas de paramètre propre reçoit cette valeur par défaut comme paramètre à l'échelle de l'organisation, y compris les Plugins ajoutés ultérieurement.

Valider le dépôt d'une marketplace de plugins
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_repository

Vérifiez si une marketplace de plugins hébergée dans un dépôt GitHub public se synchroniserait dans claude.ai, sans la connecter ni la stocker.

Valider l'archive d'une marketplace de plugins
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_archive

Vérifiez si une marketplace de plugins, téléversée sous forme de fichier .zip du répertoire de la marketplace, se synchroniserait dans claude.ai, sans la connecter ni la stocker.