Claude Platform Docs

Bêta

Models
beta_api_error: object{ message, type }
message: string
type: "api_error"
beta_authentication_error: object{ message, type }
message: string
type: "authentication_error"
beta_billing_error: object{ message, type }
message: string
type: "billing_error"
beta_currency: "USD"
"USD"
beta_error: BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
beta_error_response: object{ error, request_id, type }
beta_gateway_timeout_error: object{ message, type }
message: string
type: "timeout_error"
beta_invalid_request_error: object{ message, type }
message: string
type: "invalid_request_error"
beta_monetary_amount: 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: "USD"

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.

beta_not_found_error: object{ message, type }
message: string
type: "not_found_error"
beta_overloaded_error: object{ message, type }
message: string
type: "overloaded_error"
beta_permission_error: object{ message, type }
message: string
type: "permission_error"
beta_rate_limit_error: object{ message, type }
message: string
type: "rate_limit_error"

BêtaModèles

Lister les modèles
$ ant beta:models list
GET/v1/models
Obtenir un modèle
$ ant beta:models retrieve
GET/v1/models/{model_id}

BêtaMessages

Créer un message
$ ant beta:messages create
POST/v1/messages
Compter les tokens d'un message
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

BêtaMessagesLots

Créer un lot de messages
$ ant beta:messages:batches create
POST/v1/messages/batches
Récupérer un lot de messages
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}
Lister les lots de messages
$ ant beta:messages:batches list
GET/v1/messages/batches
Annuler un lot de messages
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel
Supprimer un lot de messages
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}
Récupérer les résultats d'un lot de messages
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

BêtaAgents

Créer un agent
$ ant beta:agents create
POST/v1/agents
Lister les agents
$ ant beta:agents list
GET/v1/agents
Obtenir un agent
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
Mettre à jour un agent
$ ant beta:agents update
POST/v1/agents/{agent_id}
Archiver un agent
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

BêtaAgentsVersions

Lister les versions d'un agent
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

BêtaEnvironnements

Créer un environnement
$ ant beta:environments create
POST/v1/environments
Lister les environnements
$ ant beta:environments list
GET/v1/environments
Obtenir un environnement
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}
Mettre à jour un environnement
$ ant beta:environments update
POST/v1/environments/{environment_id}
Supprimer un environnement
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}
Archiver un environnement
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

BêtaEnvironnementsTravail

Obtenir un élément de travail
$ ant beta:environments:work retrieve
GET/v1/environments/{environment_id}/work/{work_id}
Interroger pour obtenir du travail
$ ant beta:environments:work poll
GET/v1/environments/{environment_id}/work/poll
Accuser réception d'un travail
$ ant beta:environments:work ack
POST/v1/environments/{environment_id}/work/{work_id}/ack
Enregistrer un signal de présence
$ ant beta:environments:work heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Arrêter un travail
$ ant beta:environments:work stop
POST/v1/environments/{environment_id}/work/{work_id}/stop
Lister les éléments de travail
$ ant beta:environments:work list
GET/v1/environments/{environment_id}/work
Mettre à jour un élément de travail
$ ant beta:environments:work update
POST/v1/environments/{environment_id}/work/{work_id}
Obtenir les statistiques de la file d'attente
$ ant beta:environments:work stats
GET/v1/environments/{environment_id}/work/stats

BêtaSessions

Créer une session
$ ant beta:sessions create
POST/v1/sessions
Lister les sessions
$ ant beta:sessions list
GET/v1/sessions
Obtenir une session
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
Mettre à jour une session
$ ant beta:sessions update
POST/v1/sessions/{session_id}
Supprimer une session
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
Archiver une session
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

BêtaSessionsÉvénements

Lister les événements
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
Envoyer des événements
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
Diffuser les événements en streaming
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

BêtaSessionsRessources

Ajouter une ressource de session
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
Lister les ressources de session
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
Obtenir une ressource de session
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
Mettre à jour une ressource de session
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
Supprimer une ressource de session
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BêtaSessionsFils

Lister les fils de session
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
Obtenir un fil de session
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
Archiver un fil de session
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BêtaSessionsFilsÉvénements

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

BêtaDéploiements

Créer un déploiement
$ ant beta:deployments create
POST/v1/deployments
Lister les déploiements
$ ant beta:deployments list
GET/v1/deployments
Obtenir un déploiement
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
Mettre à jour un déploiement
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
Archiver un déploiement
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
Exécuter un déploiement maintenant
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
Mettre en pause un déploiement
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
Reprendre un déploiement
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

BêtaExécutions de déploiement

Lister les exécutions de déploiement
$ ant beta:deployment-runs list
GET/v1/deployment_runs
Obtenir une exécution de déploiement
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

BêtaCoffres-forts

Créer un coffre-fort
$ ant beta:vaults create
POST/v1/vaults
Lister les coffres-forts
$ ant beta:vaults list
GET/v1/vaults
Obtenir un coffre-fort
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
Mettre à jour un coffre-fort
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
Supprimer un coffre-fort
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
Archiver un coffre-fort
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

BêtaCoffres-fortsIdentifiants

Créer un identifiant
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
Lister les identifiants
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Obtenir un identifiant
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Mettre à jour un identifiant
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Supprimer un identifiant
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archiver un identifiant
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Valider un identifiant
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BêtaMagasins de mémoire

Créer un magasin de mémoire
$ ant beta:memory-stores create
POST/v1/memory_stores
Lister les magasins de mémoire
$ ant beta:memory-stores list
GET/v1/memory_stores
Récupérer un magasin de mémoire
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
Mettre à jour un magasin de mémoire
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
Supprimer un magasin de mémoire
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
Archiver un magasin de mémoire
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

BêtaMagasins de mémoireMémoires

Créer une mémoire
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
Lister les mémoires
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
Récupérer une mémoire
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Mettre à jour une mémoire
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Supprimer une mémoire
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BêtaMagasins de mémoireVersions de mémoire

Lister les versions de mémoire
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
Récupérer une version de mémoire
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Expurger une version de mémoire
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BêtaFichiers

Téléverser un fichier
$ ant beta:files upload
POST/v1/files
Lister les fichiers
$ ant beta:files list
GET/v1/files
Télécharger un fichier
$ ant beta:files download
GET/v1/files/{file_id}/content
Obtenir les métadonnées d'un fichier
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
Supprimer un fichier
$ ant beta:files delete
DELETE/v1/files/{file_id}

BêtaCompétences

Créer un Skill
$ ant beta:skills create
POST/v1/skills
Lister les Skills
$ ant beta:skills list
GET/v1/skills
Obtenir un Skill
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
Supprimer un Skill
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

BêtaCompétencesVersions

Créer une version de Skill
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
Lister les versions de Skill
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
Télécharger le contenu d'une version de skill
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content
Obtenir une version de Skill
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
Supprimer une version de Skill
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

BêtaProfils utilisateur

Créer un profil utilisateur
$ ant beta:user-profiles create
POST/v1/user_profiles
Lister les profils utilisateur
$ ant beta:user-profiles list
GET/v1/user_profiles
Obtenir un profil utilisateur
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Mettre à jour un profil utilisateur
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Créer une URL d'inscription
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BêtaRêves

Créer un Dream
$ ant beta:dreams create
POST/v1/dreams
Lister les Dreams
$ ant beta:dreams list
GET/v1/dreams
Obtenir un Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}
Annuler un Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel
Archiver un Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

BêtaTunnels

Créer un tunnel
$ ant beta:tunnels create
POST/v1/tunnels
Obtenir un tunnel
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}
Lister les tunnels
$ ant beta:tunnels list
GET/v1/tunnels
Archiver un tunnel
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive
Révéler le jeton d'un tunnel
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token
Effectuer la rotation du jeton d'un tunnel
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

BêtaTunnelsCertificats

Créer un certificat de tunnel
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates
Obtenir un certificat de tunnel
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Lister les certificats de tunnel
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates
Archiver un certificat de tunnel
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BêtaOrganisation

Obtenir l'organisation actuelle
$ ant beta:organization retrieve
GET/v1/organizations/me

BêtaOrganisationClés API

Lister les clés API
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Obtenir une clé API
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}
Mettre à jour une clé API
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

BêtaOrganisationClés externes

Créer une clé externe
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
Lister les clés externes
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Obtenir une clé externe
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Mettre à jour une clé externe
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Supprimer une clé externe
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Valider une clé externe
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

BêtaOrganisationFédérationÉmetteurs

Créer un émetteur de fédération
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers
Lister les émetteurs de fédération
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers
Obtenir un émetteur de fédération
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Mettre à jour un émetteur de fédération
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archiver un émetteur de fédération
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BêtaOrganisationFédérationRègles

Créer une règle de fédération
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules
Lister les règles de fédération
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules
Obtenir une règle de fédération
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}
Mettre à jour une règle de fédération
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}
Archiver une règle de fédération
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BêtaOrganisationFédérationRèglesEspaces de travail

Ajouter un espace de travail à une règle de fédération
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Lister les espaces de travail d'une règle de fédération
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Retirer un espace de travail d'une règle de fédération
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BêtaOrganisationInvitations

Créer une invitation
$ ant beta:organization:invites create
POST/v1/organizations/invites
Lister les invitations
$ ant beta:organization:invites list
GET/v1/organizations/invites
Obtenir une invitation
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}
Supprimer une invitation
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

BêtaOrganisationComptes de service

Créer un compte de service
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts
Lister les comptes de service
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts
Obtenir un compte de service
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}
Mettre à jour un compte de service
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}
Archiver un compte de service
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

BêtaOrganisationComptes de serviceEspaces de travail

Ajouter un espace de travail à un compte de service
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Lister les espaces de travail d'un compte de service
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Retirer un espace de travail d'un compte de service
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BêtaOrganisationUtilisateurs

Lister les utilisateurs
$ ant beta:organization:users list
GET/v1/organizations/users
Obtenir un utilisateur
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}
Mettre à jour un utilisateur
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}
Retirer un utilisateur
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

BêtaOrganisationEspaces de travail

Lister les espaces de travail
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Créer un espace de travail
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Obtenir un espace de travail
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Mettre à jour un espace de travail
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Archiver un espace de travail
$ ant beta:organization:workspaces archive
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
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BêtaOrganisationEspaces de travailMembres

Lister les membres d'un espace de travail
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Créer un membre d'espace de travail
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Obtenir un membre d'espace de travail
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Mettre à jour un membre d'espace de travail
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Supprimer un membre d'espace de travail
$ ant beta:organization:workspaces:members remove
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
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Créer un membre d'espace de travail de type compte de service
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Obtenir un membre d'espace de travail de type compte de service
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Mettre à jour un membre d'espace de travail de type compte de service
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Supprimer un membre d'espace de travail de type compte de service
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BêtaOrganisationLimites de débit

Lister les limites de débit de l'organisation
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

BêtaOrganisationParamètres de conformité

Obtenir les paramètres de conformité
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings
Mettre à jour les paramètres de conformité
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings