Claude Platform Docs

Beta

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

BetaModelos

Listar modelos
client.beta.models.list(params?, options?): Page<BetaModelInfo>
GET/v1/models

Lista los modelos disponibles.

Obtener un modelo
client.beta.models.retrieve(modelID, params?, options?): BetaModelInfo
GET/v1/models/{model_id}

Obtiene un modelo específico.

BetaMensajes

Crear un mensaje
client.beta.messages.create(params, options?): BetaMessage | Stream<BetaRawMessageStreamEvent>
POST/v1/messages

Envía una lista estructurada de mensajes de entrada con contenido de texto o imágenes, y el modelo generará el siguiente mensaje de la conversación.

Contar tokens en un mensaje
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount
POST/v1/messages/count_tokens

Cuenta el número de tokens en un mensaje.

BetaMensajesLotes

Crear un lote de mensajes
client.beta.messages.batches.create(params, options?): BetaMessageBatch
POST/v1/messages/batches

Envía un lote de solicitudes de creación de mensajes.

Recuperar un lote de mensajes
client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}

Este endpoint es idempotente y puede usarse para sondear la finalización de un lote de mensajes. Para acceder a los resultados de un lote de mensajes, realiza una solicitud al campo results_url de la respuesta.

Listar lotes de mensajes
client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>
GET/v1/messages/batches

Lista todos los lotes de mensajes dentro de un Workspace. Los lotes creados más recientemente se devuelven primero.

Cancelar un lote de mensajes
client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

Los lotes pueden cancelarse en cualquier momento antes de que finalice el procesamiento. Una vez iniciada la cancelación, el lote entra en estado canceling, momento en el cual el sistema puede completar cualquier solicitud en curso no interrumpible antes de finalizar la cancelación.

Eliminar un lote de mensajes
client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}

Elimina un lote de mensajes.

Recuperar resultados de un lote de mensajes
client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>
GET/v1/messages/batches/{message_batch_id}/results

Devuelve en streaming los resultados de un lote de mensajes como un archivo .jsonl.

BetaAgentes

Crear agente
client.beta.agents.create(params, options?): BetaManagedAgentsAgent
POST/v1/agents
Listar agentes
client.beta.agents.list(params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents
Obtener agente
client.beta.agents.retrieve(agentID, params?, options?): BetaManagedAgentsAgent
GET/v1/agents/{agent_id}
Actualizar agente
client.beta.agents.update(agentID, params, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}
Archivar agente
client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}/archive

BetaAgentesVersiones

Listar versiones de agente
client.beta.agents.versions.list(agentID, params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents/{agent_id}/versions

BetaEntornos

Crear entorno
client.beta.environments.create(params, options?): BetaEnvironment
POST/v1/environments

Crea un nuevo entorno con la configuración especificada.

Listar entornos
client.beta.environments.list(params?, options?): PageCursor<BetaEnvironment>
GET/v1/environments

Lista entornos con soporte de paginación.

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

Recupera un entorno específico por ID.

Actualizar entorno
client.beta.environments.update(environmentID, params, options?): BetaEnvironment
POST/v1/environments/{environment_id}

Actualiza la configuración de un entorno existente.

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

Elimina un entorno por ID. Devuelve una confirmación de la eliminación.

Archivar entorno
client.beta.environments.archive(environmentID, params?, options?): BetaEnvironment
POST/v1/environments/{environment_id}/archive

Archiva un entorno por ID. Los entornos archivados no pueden usarse para crear nuevas sesiones.

BetaEntornosTrabajo

Obtener elemento de trabajo
client.beta.environments.work.retrieve(workID, params, options?): BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Sondear en busca de trabajo
client.beta.environments.work.poll(environmentID, params?, options?): BetaSelfHostedWork | null
GET/v1/environments/{environment_id}/work/poll

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Confirmar recepción de trabajo
client.beta.environments.work.ack(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Registrar heartbeat
client.beta.environments.work.heartbeat(workID, params, options?): BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Detener trabajo
client.beta.environments.work.stop(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Listar elementos de trabajo
client.beta.environments.work.list(environmentID, params?, options?): PageCursor<BetaSelfHostedWork>
GET/v1/environments/{environment_id}/work

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Actualizar elemento de trabajo
client.beta.environments.work.update(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}

Nota: estos endpoints son llamados automáticamente por el worker de entorno prediseñado que se proporciona en los SDK y la CLI, para orquestar sesiones con entornos sandbox autoalojados. Se incluyen aquí como referencia; no necesitas invocarlos directamente.

Obtener estadísticas de la cola
client.beta.environments.work.stats(environmentID, params?, options?): BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

Obtiene estadísticas sobre la cola de trabajo de un entorno.

BetaSesiones

Crear sesión
client.beta.sessions.create(params, options?): BetaManagedAgentsSession
POST/v1/sessions
Listar sesiones
client.beta.sessions.list(params?, options?): BidirectionalPageCursor<BetaManagedAgentsSession>
GET/v1/sessions
Obtener sesión
client.beta.sessions.retrieve(sessionID, params?, options?): BetaManagedAgentsSession
GET/v1/sessions/{session_id}
Actualizar sesión
client.beta.sessions.update(sessionID, params, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}
Eliminar sesión
client.beta.sessions.delete(sessionID, params?, options?): BetaManagedAgentsDeletedSession
DELETE/v1/sessions/{session_id}
Archivar sesión
client.beta.sessions.archive(sessionID, params?, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}/archive

BetaSesionesEventos

Listar eventos
client.beta.sessions.events.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/events
Enviar eventos
client.beta.sessions.events.send(sessionID, params, options?): BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
Streaming de eventos
client.beta.sessions.events.stream(sessionID, params?, options?): BetaManagedAgentsStreamSessionEvents | Stream<BetaManagedAgentsStreamSessionEvents>
GET/v1/sessions/{session_id}/events/stream

BetaSesionesRecursos

Agregar recurso de sesión
client.beta.sessions.resources.add(sessionID, params, options?): BetaManagedAgentsFileResource
POST/v1/sessions/{session_id}/resources
Listar recursos de sesión
client.beta.sessions.resources.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionResource>
GET/v1/sessions/{session_id}/resources
Obtener recurso de sesión
client.beta.sessions.resources.retrieve(resourceID, params, options?): ResourceRetrieveResponse
GET/v1/sessions/{session_id}/resources/{resource_id}
Actualizar recurso de sesión
client.beta.sessions.resources.update(resourceID, params, options?): ResourceUpdateResponse
POST/v1/sessions/{session_id}/resources/{resource_id}
Eliminar recurso de sesión
client.beta.sessions.resources.delete(resourceID, params, options?): BetaManagedAgentsDeleteSessionResource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSesionesHilos

Listar hilos de sesión
client.beta.sessions.threads.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionThread>
GET/v1/sessions/{session_id}/threads
Obtener hilo de sesión
client.beta.sessions.threads.retrieve(threadID, params, options?): BetaManagedAgentsSessionThread
GET/v1/sessions/{session_id}/threads/{thread_id}
Archivar hilo de sesión
client.beta.sessions.threads.archive(threadID, params, options?): BetaManagedAgentsSessionThread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSesionesHilosEventos

Listar eventos de hilo de sesión
client.beta.sessions.threads.events.list(threadID, params, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Streaming de eventos de hilo de sesión
client.beta.sessions.threads.events.stream(threadID, params, options?): BetaManagedAgentsStreamSessionThreadEvents | Stream<BetaManagedAgentsStreamSessionThreadEvents>
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDespliegues

Crear despliegue
client.beta.deployments.create(params, options?): BetaManagedAgentsDeployment
POST/v1/deployments
Listar despliegues
client.beta.deployments.list(params?, options?): PageCursor<BetaManagedAgentsDeployment>
GET/v1/deployments
Obtener despliegue
client.beta.deployments.retrieve(deploymentID, params?, options?): BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
Actualizar despliegue
client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
Archivar despliegue
client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Ejecutar despliegue ahora
client.beta.deployments.run(deploymentID, params?, options?): BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Pausar despliegue
client.beta.deployments.pause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Reanudar despliegue
client.beta.deployments.unpause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause

BetaEjecuciones de despliegue

Listar ejecuciones de despliegue
client.beta.deploymentRuns.list(params?, options?): PageCursor<BetaManagedAgentsDeploymentRun>
GET/v1/deployment_runs
Obtener ejecución de despliegue
client.beta.deploymentRuns.retrieve(deploymentRunID, params?, options?): BetaManagedAgentsDeploymentRun
GET/v1/deployment_runs/{deployment_run_id}

BetaBóvedas

Crear bóveda
client.beta.vaults.create(params, options?): BetaManagedAgentsVault
POST/v1/vaults
Listar bóvedas
client.beta.vaults.list(params?, options?): PageCursor<BetaManagedAgentsVault>
GET/v1/vaults
Obtener bóveda
client.beta.vaults.retrieve(vaultID, params?, options?): BetaManagedAgentsVault
GET/v1/vaults/{vault_id}
Actualizar bóveda
client.beta.vaults.update(vaultID, params, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}
Eliminar bóveda
client.beta.vaults.delete(vaultID, params?, options?): BetaManagedAgentsDeletedVault
DELETE/v1/vaults/{vault_id}
Archivar bóveda
client.beta.vaults.archive(vaultID, params?, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}/archive

BetaBóvedasCredenciales

Crear credencial
client.beta.vaults.credentials.create(vaultID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials
Listar credenciales
client.beta.vaults.credentials.list(vaultID, params?, options?): PageCursor<BetaManagedAgentsCredential>
GET/v1/vaults/{vault_id}/credentials
Obtener credencial
client.beta.vaults.credentials.retrieve(credentialID, params, options?): BetaManagedAgentsCredential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Actualizar credencial
client.beta.vaults.credentials.update(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Eliminar credencial
client.beta.vaults.credentials.delete(credentialID, params, options?): BetaManagedAgentsDeletedCredential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archivar credencial
client.beta.vaults.credentials.archive(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
client.beta.vaults.credentials.mcpOAuthValidate(credentialID, params, options?): BetaManagedAgentsCredentialValidation
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaAlmacenes de memoria

Crear un almacén de memoria
client.beta.memoryStores.create(params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores
Listar almacenes de memoria
client.beta.memoryStores.list(params?, options?): PageCursor<BetaManagedAgentsMemoryStore>
GET/v1/memory_stores
Recuperar un almacén de memoria
client.beta.memoryStores.retrieve(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
GET/v1/memory_stores/{memory_store_id}
Actualizar un almacén de memoria
client.beta.memoryStores.update(memoryStoreID, params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}
Eliminar un almacén de memoria
client.beta.memoryStores.delete(memoryStoreID, params?, options?): BetaManagedAgentsDeletedMemoryStore
DELETE/v1/memory_stores/{memory_store_id}
Archivar un almacén de memoria
client.beta.memoryStores.archive(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}/archive

BetaAlmacenes de memoriaMemorias

Crear una memoria
client.beta.memoryStores.memories.create(memoryStoreID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories
Listar memorias
client.beta.memoryStores.memories.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryListItem>
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar una memoria
client.beta.memoryStores.memories.retrieve(memoryID, params, options?): BetaManagedAgentsMemory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Actualizar una memoria
client.beta.memoryStores.memories.update(memoryID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Eliminar una memoria
client.beta.memoryStores.memories.delete(memoryID, params, options?): BetaManagedAgentsDeletedMemory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaAlmacenes de memoriaVersiones de memoria

Listar versiones de memoria
client.beta.memoryStores.memoryVersions.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryVersion>
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar una versión de memoria
client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Expurgar una versión de memoria
client.beta.memoryStores.memoryVersions.redact(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArchivos

Cargar archivo
client.beta.files.upload(params, options?): BetaFileMetadata
POST/v1/files
Listar archivos
client.beta.files.list(params?, options?): PageCursor<BetaFileMetadata>
GET/v1/files
Descargar archivo
client.beta.files.download(fileID, params?, options?): Response
GET/v1/files/{file_id}/content
Obtener metadatos de archivo
client.beta.files.retrieveMetadata(fileID, params?, options?): BetaFileMetadata
GET/v1/files/{file_id}
Eliminar archivo
client.beta.files.delete(fileID, params?, options?): BetaDeletedFile
DELETE/v1/files/{file_id}

BetaHabilidades

Crear Skill
client.beta.skills.create(params, options?): BetaSkill
POST/v1/skills
Listar Skills
client.beta.skills.list(params?, options?): PageCursor<BetaSkill>
GET/v1/skills
Obtener Skill
client.beta.skills.retrieve(skillID, params?, options?): BetaSkill
GET/v1/skills/{skill_id}
Eliminar Skill
client.beta.skills.delete(skillID, params?, options?): BetaDeletedSkill
DELETE/v1/skills/{skill_id}

BetaHabilidadesVersiones

Crear versión de Skill
client.beta.skills.versions.create(skillID, params, options?): BetaSkillVersion
POST/v1/skills/{skill_id}/versions
Listar versiones de Skill
client.beta.skills.versions.list(skillID, params?, options?): PageCursor<BetaSkillVersion>
GET/v1/skills/{skill_id}/versions
Descargar contenido de versión de skill
client.beta.skills.versions.download(version, params, options?): Response
GET/v1/skills/{skill_id}/versions/{version}/content

Descarga el contenido de una versión de skill como archivo zip.

Obtener versión de Skill
client.beta.skills.versions.retrieve(version, params, options?): BetaSkillVersion
GET/v1/skills/{skill_id}/versions/{version}
Eliminar versión de Skill
client.beta.skills.versions.delete(version, params, options?): BetaDeletedSkillVersion
DELETE/v1/skills/{skill_id}/versions/{version}

BetaPerfiles de usuario

Crear perfil de usuario
client.beta.userProfiles.create(params, options?): BetaUserProfile
POST/v1/user_profiles
Listar perfiles de usuario
client.beta.userProfiles.list(params?, options?): PageCursor<BetaUserProfile>
GET/v1/user_profiles
Obtener perfil de usuario
client.beta.userProfiles.retrieve(userProfileID, params?, options?): BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
Actualizar perfil de usuario
client.beta.userProfiles.update(userProfileID, params, options?): BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
Crear URL de inscripción
client.beta.userProfiles.createEnrollmentURL(userProfileID, params?, options?): BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaSueños

Crear un Dream
client.beta.dreams.create(params, options?): BetaDream
POST/v1/dreams

Inicia un trabajo asíncrono que usa sesiones anteriores para producir una versión reorganizada de un almacén de memoria y devuelve el dream para que lo consultes periódicamente hasta obtener el resultado.

Listar Dreams
client.beta.dreams.list(params?, options?): PageCursor<BetaDream>
GET/v1/dreams

Lista los dreams del espacio de trabajo, del más reciente al más antiguo.

Obtener un Dream
client.beta.dreams.retrieve(dreamID, params?, options?): BetaDream
GET/v1/dreams/{dream_id}

Obtén un dream por ID para verificar su estado, el almacén de memoria de salida y el uso de tokens.

Cancelar un Dream
client.beta.dreams.cancel(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/cancel

Detén un dream en estado pending o running.

Archivar un Dream
client.beta.dreams.archive(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/archive

Oculta un dream completed, failed o canceled de la lista predeterminada de dreams.

BetaTúneles

Crear túnel
client.beta.tunnels.create(params, options?): BetaTunnel
POST/v1/tunnels

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Obtener túnel
client.beta.tunnels.retrieve(tunnelID, params?, options?): BetaTunnel
GET/v1/tunnels/{tunnel_id}

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Listar túneles
client.beta.tunnels.list(params?, options?): PageCursor<BetaTunnel>
GET/v1/tunnels

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Archivar túnel
client.beta.tunnels.archive(tunnelID, params?, options?): BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Revelar token de túnel
client.beta.tunnels.revealToken(tunnelID, params?, options?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/reveal_token

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Rotar token de túnel
client.beta.tunnels.rotateToken(tunnelID, params, options?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/rotate_token

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

BetaTúnelesCertificados

Crear certificado de túnel
client.beta.tunnels.certificates.create(tunnelID, params, options?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Obtener certificado de túnel
client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Listar certificados de túnel
client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor<BetaTunnelCertificate>
GET/v1/tunnels/{tunnel_id}/certificates

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

Archivar certificado de túnel
client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

La API de Tunnels está en vista previa de investigación. Requiere el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y puede cambiar sin un período de obsolescencia. Reemplaza los endpoints de la Admin API en /v1/organizations/tunnels, que siguen disponibles durante un período de migración.

BetaOrganización

Obtener la organización actual
client.beta.organization.retrieve(options?): BetaOrganization
GET/v1/organizations/me

Recupera información sobre la organización asociada con la clave de API autenticada.

BetaOrganizaciónClaves de API

Listar claves de API
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>
GET/v1/organizations/api_keys
Recuperar clave de API (Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}

Recupera información sobre una sola clave de API de tu organización, buscada por su ID. Este endpoint de la Admin API requiere una clave de Admin API, está pensado para la administración programática de claves y nunca devuelve el valor secreto de la clave. Para ver o crear tus propias claves de API, ve a Claves de API en la Claude Console.

Actualizar clave de API
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaciónClaves externas

Crear clave externa
client.beta.organization.externalKeys.create(body, options?): BetaExternalKey
POST/v1/organizations/external_keys

Crea una configuración de clave externa propiedad de la organización del llamador.

Listar claves externas
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys

Lista las configuraciones de claves externas de la organización del llamador.

Obtener clave externa
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}

Recupera una sola configuración de clave externa de la organización del llamador por ID.

Actualizar clave externa
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}

Actualiza parcialmente una configuración de clave externa. Los campos omitidos no se modifican.

Eliminar clave externa
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Elimina una configuración de clave externa.

Validar clave externa
client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

Valida una configuración de clave externa contra el KMS del cliente.

BetaOrganizaciónFederaciónEmisores

Crear emisor de federación
client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Listar emisores de federación
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<BetaFederationIssuer>
GET/v1/organizations/federation_issuers

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Obtener emisor de federación
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Actualizar emisor de federación
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Archivar emisor de federación
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

BetaOrganizaciónFederaciónReglas

Crear regla de federación
client.beta.organization.federation.rules.create(params, options?): BetaFederationRule
POST/v1/organizations/federation_rules

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Listar reglas de federación
client.beta.organization.federation.rules.list(params?, options?): PageCursor<BetaFederationRule>
GET/v1/organizations/federation_rules

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Obtener regla de federación
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Actualizar regla de federación
client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Archivar regla de federación
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

BetaOrganizaciónFederaciónReglasEspacios de trabajo

Agregar espacio de trabajo a la regla de federación
client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Listar espacios de trabajo de la regla de federación
client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor<BetaFederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Quitar espacio de trabajo de la regla de federación
client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

BetaOrganizaciónInvitaciones

Crear invitación
client.beta.organization.invites.create(body, options?): BetaOrganizationInvite
POST/v1/organizations/invites

Invita a un usuario a unirse a la organización por correo electrónico.

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

Lista las invitaciones de la organización.

Obtener invitación
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}

Recupera una invitación por ID.

Eliminar invitación
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Elimina una invitación pendiente.

BetaOrganizaciónCuentas de servicio

Crear cuenta de servicio
client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount
POST/v1/organizations/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Listar cuentas de servicio
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<BetaServiceAccount>
GET/v1/organizations/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Obtener cuenta de servicio
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Actualizar cuenta de servicio
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Archivar cuenta de servicio
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

BetaOrganizaciónCuentas de servicioEspacios de trabajo

Agregar espacio de trabajo a la cuenta de servicio
client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Listar espacios de trabajo de la cuenta de servicio
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Quitar espacio de trabajo de la cuenta de servicio
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

BetaOrganizaciónUsuarios

Listar usuarios
client.beta.organization.users.list(query?, options?): Page<BetaOrganizationUser>
GET/v1/organizations/users

Lista los miembros de la organización.

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

Recupera un miembro de la organización por ID de usuario.

Actualizar usuario
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}

Actualiza el rol de un miembro en la organización.

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

Quita a un miembro de la organización.

BetaOrganizaciónEspacios de trabajo

Listar espacios de trabajo
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>
GET/v1/organizations/workspaces
Crear espacio de trabajo
client.beta.organization.workspaces.create(params, options?): BetaWorkspace
POST/v1/organizations/workspaces
Obtener espacio de trabajo
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Actualizar espacio de trabajo
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archivar espacio de trabajo
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizaciónEspacios de trabajoLímites de velocidad

Listar límites de velocidad del espacio de trabajo
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Lista los límites de velocidad de un espacio de trabajo.

BetaOrganizaciónEspacios de trabajoMiembros

Listar miembros del espacio de trabajo
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Crear miembro del espacio de trabajo
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Obtener miembro del espacio de trabajo
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Actualizar miembro del espacio de trabajo
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Eliminar miembro del espacio de trabajo
client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizaciónEspacios de trabajoCuentas de servicio

Listar cuentas de servicio miembros del espacio de trabajo
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Crear cuenta de servicio miembro del espacio de trabajo
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Obtener cuenta de servicio miembro del espacio de trabajo
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Actualizar cuenta de servicio miembro del espacio de trabajo
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de Admin API. Consulta Administrar WIF con la Admin API.

Eliminar cuenta de servicio miembro del espacio de trabajo
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido de ant auth login --scope org:admin o de una regla de federación de identidades de carga de trabajo; no se aceptan claves de API de administrador. Consulta Administrar WIF con la Admin API.

BetaOrganizaciónLímites de velocidad

Enumerar límites de velocidad de la organización
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>
GET/v1/organizations/rate_limits

Enumera los límites de velocidad de la Messages API para tu organización.

BetaOrganizaciónConfiguración de cumplimiento

Obtener configuración de cumplimiento
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettings
GET/v1/organizations/compliance_settings

Recupera la configuración de cumplimiento (Compliance Settings) de tu organización.

Actualizar configuración de cumplimiento
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettings
POST/v1/organizations/compliance_settings

Actualiza la configuración de cumplimiento (Compliance Settings) de tu organización.

BetaOrganizaciónAnalíticaResúmenes

Obtener resúmenes de actividad
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>
GET/v1/organizations/analytics/summaries

Obtén resúmenes de actividad de toda la organización para un rango de fechas.

BetaOrganizaciónAnalíticaUsuarios

Listar actividad de usuarios
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>
GET/v1/organizations/analytics/users

Obtiene la actividad por usuario de un día determinado, con paginación basada en cursor.

BetaOrganizaciónAnalíticaAplicacionesChatProyectos

Obtener uso de proyectos de chat
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>
GET/v1/organizations/analytics/apps/chat/projects

Obtiene la actividad por proyecto para un día determinado, con paginación basada en cursor.

BetaOrganizaciónAnalíticaConectores

Obtener uso de conectores
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>
GET/v1/organizations/analytics/connectors

Obtiene el uso por conector de un día determinado, con paginación basada en cursor.

BetaOrganizaciónAnalíticaPlugins

Obtener uso de plugins
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>
GET/v1/organizations/analytics/plugins

Obtiene el uso de instalación e invocación por plugin de un día determinado, con paginación.

BetaOrganizaciónAnalíticaHabilidades

Obtener uso de skills
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>
GET/v1/organizations/analytics/skills

Obtiene el uso por skill de un día determinado, con paginación basada en cursor.

BetaOrganizaciónAnalíticaArtifacts

Obtener actividad de artifacts
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>
GET/v1/organizations/analytics/artifacts

Obtiene la actividad de creación de artifacts de un día determinado, desglosada por tipo MIME.

BetaOrganizaciónAnalíticaInforme de uso

Obtener uso de tokens a lo largo del tiempo
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>
GET/v1/organizations/analytics/usage_report

Obtiene el uso de tokens a lo largo del tiempo en un rango de fechas.

BetaOrganizaciónAnalíticaInforme de uso por usuario

Obtener uso de tokens por usuario
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>
GET/v1/organizations/analytics/user_usage_report

Obtiene el uso de tokens por usuario en un rango de fechas.

BetaOrganizaciónAnalíticaInforme de costos

Obtener costo a lo largo del tiempo
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>
GET/v1/organizations/analytics/cost_report

Obtiene el costo en USD a lo largo del tiempo en un rango de fechas.

BetaOrganizaciónAnalíticaInforme de costos por usuario

Obtener costo por usuario
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>
GET/v1/organizations/analytics/user_cost_report

Obtiene el costo por usuario en USD en un rango de fechas.

BetaOrganizaciónLímites de gasto

Establecer límite de gasto
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimit
POST/v1/organizations/spend_limits

Establece un límite de gasto.

Obtener límite de gasto
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimit
GET/v1/organizations/spend_limits/{spend_limit_id}

Recupera un límite de gasto por ID.

Eliminar límite de gasto
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponse
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Elimina un límite de gasto.

Listar límites de gasto
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>
GET/v1/organizations/spend_limits

Lista los límites de gasto de la organización.

BetaOrganizaciónLímites de gastoEfectivos

Listar límites de gasto efectivos
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>
GET/v1/organizations/spend_limits/effective

Lista el límite de gasto efectivo de cada miembro y el gasto acumulado en el período.

BetaOrganizaciónLímites de gastoSolicitudes de aumento

Listar solicitudes de aumento de límite de gasto
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>
GET/v1/organizations/spend_limit_increase_requests

Lista las solicitudes de aumento de límite de gasto, las más recientes primero.

Obtener solicitud de aumento de límite de gasto
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequest
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Recupera una solicitud de aumento de límite de gasto.

Aprobar solicitud de aumento de límite de gasto
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponse
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Aprueba una solicitud pendiente de aumento de límite de gasto.

Denegar solicitud de aumento de límite de gasto
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequest
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Deniega una solicitud pendiente de aumento de límite de gasto.

BetaOrganizaciónGrupos RBAC

Crear grupo RBAC
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroup
POST/v1/organizations/rbac_groups

Crea un grupo RBAC en el tenant de Claude Enterprise. Los grupos creados mediante la API tienen el tipo de origen "direct".

Listar grupos RBAC
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>
GET/v1/organizations/rbac_groups

Lista los grupos RBAC del tenant de Claude Enterprise.

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

Recupera un grupo RBAC por ID.

Actualizar grupo RBAC
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): BetaRBACGroup
POST/v1/organizations/rbac_groups/{rbac_group_id}

Actualiza el nombre de un grupo RBAC. Los grupos aprovisionados por un proveedor de identidad (tipo de origen "scim") no se pueden modificar mediante la API mientras una organización del tenant use aprovisionamiento SCIM.

Eliminar grupo RBAC
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): RBACGroupDeleteResponse
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Elimina un grupo RBAC. Los grupos aprovisionados por un proveedor de identidad (tipo de origen "scim") no se pueden eliminar mediante la API mientras una organización del tenant use aprovisionamiento SCIM.

BetaOrganizaciónGrupos RBACMiembros

Listar miembros de un grupo RBAC
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Lista los miembros de un grupo RBAC.

Agregar miembro a grupo RBAC
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): BetaRBACGroupMember
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Agrega un usuario a un grupo RBAC. La membresía de los grupos aprovisionados por un proveedor de identidad (tipo de origen "scim") no se puede modificar mediante la API mientras una organización del tenant use aprovisionamiento SCIM.

Quitar miembro de grupo RBAC
client.beta.organization.rbacGroups.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Quita un usuario de un grupo RBAC. La membresía de los grupos aprovisionados por un proveedor de identidad (tipo de origen "scim") no se puede modificar mediante la API mientras una organización del tenant use aprovisionamiento SCIM.

BetaOrganizaciónRoles RBAC

Listar roles RBAC
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>
GET/v1/organizations/rbac_roles

Lista los roles RBAC de la organización.

Obtener rol RBAC
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRole
GET/v1/organizations/rbac_roles/{rbac_role_id}

Recupera un rol RBAC por ID.

BetaOrganizaciónRoles RBACPermisos

Listar permisos de un rol RBAC
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

Lista los permisos que otorga un rol RBAC.

BetaOrganizaciónPlugins

Crear plugin
client.beta.organization.plugins.create(params, options?): BetaPlugin
POST/v1/organizations/plugins

Crea un plugin propiedad de la organización y su primera versión cargando los archivos de la versión.

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

Recupera un plugin por ID.

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

Cambia qué versión almacenada de un Plugin propiedad de la organización se sirve a los miembros, por ejemplo, para revertir a una anterior. Esto fija la versión servida: las cargas posteriores se almacenan, pero ya no cambian lo que se sirve, y actualmente la fijación no se puede deshacer, ni aquí ni en claude.ai.

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

Lista los Plugins creados en la organización, del más reciente al más antiguo: los de los marketplaces de plugins propios de la organización y los de los marketplaces de plugins personales de los miembros.

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

Elimina permanentemente un Plugin y todas las versiones que contiene, exactamente como cuando un administrador lo elimina en claude.ai. El Plugin puede pertenecer a la organización o a un miembro, incluido un miembro que ya haya dejado la organización.

BetaOrganizaciónPluginsVersiones

Crear versión de Plugin
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion
POST/v1/organizations/plugins/{plugin_id}/versions

Agrega una versión a un Plugin propiedad de la organización cargando los archivos de la nueva versión; se convierte en la versión que se sirve a los miembros, a menos que la versión servida del Plugin se haya fijado.

Listar versiones de Plugin
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>
GET/v1/organizations/plugins/{plugin_id}/versions

Lista las versiones de un Plugin, de la más reciente a la más antigua.

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

Recupera una versión de un Plugin por su ID, o la versión más reciente del Plugin.

Descargar archivo de versión de Plugin
client.beta.organization.plugins.versions.download(version, params, options?): Response
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Descarga el archivo .zip de una versión, exactamente como está almacenado. Cada descarga de un Plugin del marketplace de plugins personal de un miembro se registra en el feed de actividad de la Compliance API.

BetaOrganizaciónPluginsConfiguración de instalación

Listar configuraciones de instalación de Plugin
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>
GET/v1/organizations/plugins/{plugin_id}/installation_settings

Lista las configuraciones de instalación de un Plugin propiedad de la organización, que indican para qué miembros es, de la creada más recientemente a la más antigua.

Establecer configuración de instalación de Plugin
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Establece o cambia la configuración de instalación de un Plugin propiedad de la organización para toda la organización o para un grupo RBAC.

Eliminar configuración de instalación de Plugin
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Elimina la configuración de instalación propia de un Plugin propiedad de la organización para toda la organización o para un grupo RBAC.

BetaOrganizaciónPluginsComparticiones

Listar comparticiones de Plugin
client.beta.organization.plugins.shares.list(pluginID, params?, options?): PageCursor<BetaPluginShare>
GET/v1/organizations/plugins/{plugin_id}/shares

Lista las comparticiones que ha otorgado el propietario de un Plugin propiedad de un miembro (a todos los miembros de la organización, a un grupo RBAC o a un miembro), de la otorgada más recientemente a la más antigua.

BetaOrganizaciónMarketplaces de plugins

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

Lista los marketplaces de plugins en los que se encuentran los Plugins, del más reciente al más antiguo: los propios de la organización y los personales de sus miembros.

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

Recupera un marketplace de plugins por ID.

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

Establece la configuración de instalación predeterminada de uno de los marketplaces de plugins propios de la organización. Cada Plugin que contiene sin configuración propia obtiene este valor predeterminado como su configuración para toda la organización, incluidos los Plugins que se agreguen más adelante.

Validar repositorio de marketplace de plugins
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_repository

Comprueba si un marketplace de plugins alojado en un repositorio público de GitHub se sincronizaría en claude.ai, sin conectarlo ni almacenarlo.

Validar archivo de marketplace de plugins
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_archive

Comprueba si un marketplace de plugins, cargado como un .zip del directorio del marketplace, se sincronizaría en claude.ai, sin conectarlo ni almacenarlo.