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 41 more
One of the following:
BetaAPIError object{ message, type }
message: string
defaultInternal server error
type: "api_error"
defaultapi_error
BetaAuthenticationError object{ message, type }
message: string
defaultAuthentication error
type: "authentication_error"
defaultauthentication_error
BetaBillingError object{ message, type }
message: string
defaultBilling error
type: "billing_error"
defaultbilling_error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
One of the following:
BetaErrorResponse object{ error, request_id, type }
error: BetaError
One of the following:
request_id: string or null
type: "error"
defaulterror
BetaGatewayTimeoutError object{ message, type }
message: string
defaultRequest timeout
type: "timeout_error"
defaulttimeout_error
BetaInvalidRequestError object{ message, type }
message: string
defaultInvalid request
type: "invalid_request_error"
defaultinvalid_request_error
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{ message, type }
message: string
defaultNot found
type: "not_found_error"
defaultnot_found_error
BetaOverloadedError object{ message, type }
message: string
defaultOverloaded
type: "overloaded_error"
defaultoverloaded_error
BetaPermissionError object{ message, type }
message: string
defaultPermission denied
type: "permission_error"
defaultpermission_error
BetaRateLimitError object{ message, type }
message: string
defaultRate limited
type: "rate_limit_error"
defaultrate_limit_error

BêtaModèles

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

BêtaMessages

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

BêtaMessagesLots

Créer un lot de messages
POST/v1/messages/batches
Récupérer un lot de messages
GET/v1/messages/batches/{message_batch_id}
Lister les lots de messages
GET/v1/messages/batches
Annuler un lot de messages
POST/v1/messages/batches/{message_batch_id}/cancel
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

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
Lister les environnements
GET/v1/environments
Obtenir un environnement
GET/v1/environments/{environment_id}
Mettre à jour un environnement
POST/v1/environments/{environment_id}
Supprimer un environnement
DELETE/v1/environments/{environment_id}
Archiver un environnement
POST/v1/environments/{environment_id}/archive

BêtaEnvironnementsTravail

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

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
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êtaWebhooks

Unwrap
Function
Parse Unverified
Function

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
Lister les Dreams
GET/v1/dreams
Obtenir un Dream
GET/v1/dreams/{dream_id}
Annuler un Dream
POST/v1/dreams/{dream_id}/cancel
Archiver un Dream
POST/v1/dreams/{dream_id}/archive

BêtaTunnels

Créer un tunnel
POST/v1/tunnels
Obtenir un tunnel
GET/v1/tunnels/{tunnel_id}
Lister les tunnels
GET/v1/tunnels
Archiver un tunnel
POST/v1/tunnels/{tunnel_id}/archive
Révéler le jeton d'un tunnel
POST/v1/tunnels/{tunnel_id}/reveal_token
Effectuer la rotation du jeton d'un tunnel
POST/v1/tunnels/{tunnel_id}/rotate_token

BêtaTunnelsCertificats

Créer un certificat de tunnel
POST/v1/tunnels/{tunnel_id}/certificates
Obtenir un certificat de tunnel
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Lister les certificats de tunnel
GET/v1/tunnels/{tunnel_id}/certificates
Archiver un certificat de tunnel
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BêtaOrganisation

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

BêtaOrganisationClés API

Lister les clés API
GET/v1/organizations/api_keys
Obtenir une clé API
GET/v1/organizations/api_keys/{api_key_id}
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
Lister les clés externes
GET/v1/organizations/external_keys
Obtenir une clé externe
GET/v1/organizations/external_keys/{external_key_id}
Mettre à jour une clé externe
POST/v1/organizations/external_keys/{external_key_id}
Supprimer une clé externe
DELETE/v1/organizations/external_keys/{external_key_id}
Valider une clé externe
POST/v1/organizations/external_keys/{external_key_id}/validate

BêtaOrganisationFédérationÉmetteurs

Créer un émetteur de fédération
POST/v1/organizations/federation_issuers
Lister les émetteurs de fédération
GET/v1/organizations/federation_issuers
Obtenir un émetteur de fédération
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Mettre à jour un émetteur de fédération
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archiver un émetteur de fédération
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BêtaOrganisationFédérationRègles

Créer une règle de fédération
POST/v1/organizations/federation_rules
Lister les règles de fédération
GET/v1/organizations/federation_rules
Obtenir une règle de fédération
GET/v1/organizations/federation_rules/{federation_rule_id}
Mettre à jour une règle de fédération
POST/v1/organizations/federation_rules/{federation_rule_id}
Archiver une règle de fédération
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
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Lister les espaces de travail d'une règle de fédération
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Retirer un espace de travail d'une règle de fédération
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BêtaOrganisationInvitations

Créer une invitation
POST/v1/organizations/invites
Lister les invitations
GET/v1/organizations/invites
Obtenir une invitation
GET/v1/organizations/invites/{invite_id}
Supprimer une invitation
DELETE/v1/organizations/invites/{invite_id}

BêtaOrganisationComptes de service

Créer un compte de service
POST/v1/organizations/service_accounts
Lister les comptes de service
GET/v1/organizations/service_accounts
Obtenir un compte de service
GET/v1/organizations/service_accounts/{service_account_id}
Mettre à jour un compte de service
POST/v1/organizations/service_accounts/{service_account_id}
Archiver un compte de service
POST/v1/organizations/service_accounts/{service_account_id}/archive

BêtaOrganisationComptes de serviceEspaces de travail

Ajouter un espace de travail à un compte de service
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Lister les espaces de travail d'un compte de service
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Retirer un espace de travail d'un compte de service
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BêtaOrganisationUtilisateurs

Lister les utilisateurs
GET/v1/organizations/users
Obtenir un utilisateur
GET/v1/organizations/users/{user_id}
Mettre à jour un utilisateur
POST/v1/organizations/users/{user_id}
Retirer un utilisateur
DELETE/v1/organizations/users/{user_id}

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

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
Créer un membre d'espace de travail de type compte de service
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Obtenir un membre d'espace de travail de type compte de service
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Mettre à jour un membre d'espace de travail de type compte de service
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Supprimer un membre d'espace de travail de type compte de service
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
GET/v1/organizations/rate_limits

BêtaOrganisationParamètres de conformité

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