Claude Platform Docs

Beta

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

BetaModelos

Listar modelos
GET/v1/models
Obtener un modelo
GET/v1/models/{model_id}

BetaMensajes

Crear un mensaje
POST/v1/messages
Contar tokens en un mensaje
POST/v1/messages/count_tokens

BetaMensajesLotes

Crear un lote de mensajes
POST/v1/messages/batches
Recuperar un lote de mensajes
GET/v1/messages/batches/{message_batch_id}
Listar lotes de mensajes
GET/v1/messages/batches
Cancelar un lote de mensajes
POST/v1/messages/batches/{message_batch_id}/cancel
Eliminar un lote de mensajes
DELETE/v1/messages/batches/{message_batch_id}
Recuperar resultados de un lote de mensajes
GET/v1/messages/batches/{message_batch_id}/results

BetaAgentes

Crear agente
POST/v1/agents
Listar agentes
GET/v1/agents
Obtener agente
GET/v1/agents/{agent_id}
Actualizar agente
POST/v1/agents/{agent_id}
Archivar agente
POST/v1/agents/{agent_id}/archive

BetaAgentesVersiones

Listar versiones de agente
GET/v1/agents/{agent_id}/versions

BetaEntornos

Crear entorno
POST/v1/environments
Listar entornos
GET/v1/environments
Obtener entorno
GET/v1/environments/{environment_id}
Actualizar entorno
POST/v1/environments/{environment_id}
Eliminar entorno
DELETE/v1/environments/{environment_id}
Archivar entorno
POST/v1/environments/{environment_id}/archive

BetaEntornosTrabajo

Obtener elemento de trabajo
GET/v1/environments/{environment_id}/work/{work_id}
Sondear en busca de trabajo
GET/v1/environments/{environment_id}/work/poll
Confirmar recepción de trabajo
POST/v1/environments/{environment_id}/work/{work_id}/ack
Registrar heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Detener trabajo
POST/v1/environments/{environment_id}/work/{work_id}/stop
Listar elementos de trabajo
GET/v1/environments/{environment_id}/work
Actualizar elemento de trabajo
POST/v1/environments/{environment_id}/work/{work_id}
Obtener estadísticas de la cola
GET/v1/environments/{environment_id}/work/stats

BetaSesiones

Crear sesión
POST/v1/sessions
Listar sesiones
GET/v1/sessions
Obtener sesión
GET/v1/sessions/{session_id}
Actualizar sesión
POST/v1/sessions/{session_id}
Eliminar sesión
DELETE/v1/sessions/{session_id}
Archivar sesión
POST/v1/sessions/{session_id}/archive

BetaSesionesEventos

Listar eventos
GET/v1/sessions/{session_id}/events
Enviar eventos
POST/v1/sessions/{session_id}/events
Streaming de eventos
GET/v1/sessions/{session_id}/events/stream

BetaSesionesRecursos

Agregar recurso de sesión
POST/v1/sessions/{session_id}/resources
Listar recursos de sesión
GET/v1/sessions/{session_id}/resources
Obtener recurso de sesión
GET/v1/sessions/{session_id}/resources/{resource_id}
Actualizar recurso de sesión
POST/v1/sessions/{session_id}/resources/{resource_id}
Eliminar recurso de sesión
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSesionesHilos

Listar hilos de sesión
GET/v1/sessions/{session_id}/threads
Obtener hilo de sesión
GET/v1/sessions/{session_id}/threads/{thread_id}
Archivar hilo de sesión
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSesionesHilosEventos

Listar eventos de hilo de sesión
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Streaming de eventos de hilo de sesión
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDespliegues

Crear despliegue
POST/v1/deployments
Listar despliegues
GET/v1/deployments
Obtener despliegue
GET/v1/deployments/{deployment_id}
Actualizar despliegue
POST/v1/deployments/{deployment_id}
Archivar despliegue
POST/v1/deployments/{deployment_id}/archive
Ejecutar despliegue ahora
POST/v1/deployments/{deployment_id}/run
Pausar despliegue
POST/v1/deployments/{deployment_id}/pause
Reanudar despliegue
POST/v1/deployments/{deployment_id}/unpause

BetaEjecuciones de despliegue

Listar ejecuciones de despliegue
GET/v1/deployment_runs
Obtener ejecución de despliegue
GET/v1/deployment_runs/{deployment_run_id}

BetaBóvedas

Crear bóveda
POST/v1/vaults
Listar bóvedas
GET/v1/vaults
Obtener bóveda
GET/v1/vaults/{vault_id}
Actualizar bóveda
POST/v1/vaults/{vault_id}
Eliminar bóveda
DELETE/v1/vaults/{vault_id}
Archivar bóveda
POST/v1/vaults/{vault_id}/archive

BetaBóvedasCredenciales

Crear credencial
POST/v1/vaults/{vault_id}/credentials
Listar credenciales
GET/v1/vaults/{vault_id}/credentials
Obtener credencial
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Actualizar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Eliminar credencial
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archivar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaAlmacenes de memoria

Crear un almacén de memoria
POST/v1/memory_stores
Listar almacenes de memoria
GET/v1/memory_stores
Recuperar un almacén de memoria
GET/v1/memory_stores/{memory_store_id}
Actualizar un almacén de memoria
POST/v1/memory_stores/{memory_store_id}
Eliminar un almacén de memoria
DELETE/v1/memory_stores/{memory_store_id}
Archivar un almacén de memoria
POST/v1/memory_stores/{memory_store_id}/archive

BetaAlmacenes de memoriaMemorias

Crear una memoria
POST/v1/memory_stores/{memory_store_id}/memories
Listar memorias
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar una memoria
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Actualizar una memoria
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Eliminar una memoria
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaAlmacenes de memoriaVersiones de memoria

Listar versiones de memoria
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar una versión de memoria
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Expurgar una versión de memoria
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArchivos

Cargar archivo
POST/v1/files
Listar archivos
GET/v1/files
Descargar archivo
GET/v1/files/{file_id}/content
Obtener metadatos de archivo
GET/v1/files/{file_id}
Eliminar archivo
DELETE/v1/files/{file_id}

BetaHabilidades

Crear Skill
POST/v1/skills
Listar Skills
GET/v1/skills
Obtener Skill
GET/v1/skills/{skill_id}
Eliminar Skill
DELETE/v1/skills/{skill_id}

BetaHabilidadesVersiones

Crear versión de Skill
POST/v1/skills/{skill_id}/versions
Listar versiones de Skill
GET/v1/skills/{skill_id}/versions
Descargar contenido de versión de skill
GET/v1/skills/{skill_id}/versions/{version}/content
Obtener versión de Skill
GET/v1/skills/{skill_id}/versions/{version}
Eliminar versión de Skill
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhooks

Unwrap
Function
Parse Unverified
Function

BetaPerfiles de usuario

Crear perfil de usuario
POST/v1/user_profiles
Listar perfiles de usuario
GET/v1/user_profiles
Obtener perfil de usuario
GET/v1/user_profiles/{user_profile_id}
Actualizar perfil de usuario
POST/v1/user_profiles/{user_profile_id}
Crear URL de inscripción
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaSueños

Crear un Dream
POST/v1/dreams
Listar Dreams
GET/v1/dreams
Obtener un Dream
GET/v1/dreams/{dream_id}
Cancelar un Dream
POST/v1/dreams/{dream_id}/cancel
Archivar un Dream
POST/v1/dreams/{dream_id}/archive

BetaTúneles

Crear túnel
POST/v1/tunnels
Obtener túnel
GET/v1/tunnels/{tunnel_id}
Listar túneles
GET/v1/tunnels
Archivar túnel
POST/v1/tunnels/{tunnel_id}/archive
Revelar token de túnel
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotar token de túnel
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTúnelesCertificados

Crear certificado de túnel
POST/v1/tunnels/{tunnel_id}/certificates
Obtener certificado de túnel
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
Listar certificados de túnel
GET/v1/tunnels/{tunnel_id}/certificates
Archivar certificado de túnel
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganización

Obtener la organización actual
GET/v1/organizations/me

BetaOrganizaciónClaves de API

Listar claves de API
GET/v1/organizations/api_keys
Obtener clave de API
GET/v1/organizations/api_keys/{api_key_id}
Actualizar clave de API
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaciónClaves externas

Crear clave externa
POST/v1/organizations/external_keys
Listar claves externas
GET/v1/organizations/external_keys
Obtener clave externa
GET/v1/organizations/external_keys/{external_key_id}
Actualizar clave externa
POST/v1/organizations/external_keys/{external_key_id}
Eliminar clave externa
DELETE/v1/organizations/external_keys/{external_key_id}
Validar clave externa
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizaciónFederaciónEmisores

Crear emisor de federación
POST/v1/organizations/federation_issuers
Listar emisores de federación
GET/v1/organizations/federation_issuers
Obtener emisor de federación
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Actualizar emisor de federación
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archivar emisor de federación
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizaciónFederaciónReglas

Crear regla de federación
POST/v1/organizations/federation_rules
Listar reglas de federación
GET/v1/organizations/federation_rules
Obtener regla de federación
GET/v1/organizations/federation_rules/{federation_rule_id}
Actualizar regla de federación
POST/v1/organizations/federation_rules/{federation_rule_id}
Archivar regla de federación
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizaciónFederaciónReglasEspacios de trabajo

Agregar workspace a regla de federación
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Listar workspaces de una regla de federación
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Quitar workspace de regla de federación
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizaciónInvitaciones

Crear invitación
POST/v1/organizations/invites
Listar invitaciones
GET/v1/organizations/invites
Obtener invitación
GET/v1/organizations/invites/{invite_id}
Eliminar invitación
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizaciónCuentas de servicio

Crear cuenta de servicio
POST/v1/organizations/service_accounts
Listar cuentas de servicio
GET/v1/organizations/service_accounts
Obtener cuenta de servicio
GET/v1/organizations/service_accounts/{service_account_id}
Actualizar cuenta de servicio
POST/v1/organizations/service_accounts/{service_account_id}
Archivar cuenta de servicio
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizaciónCuentas de servicioEspacios de trabajo

Agregar workspace a cuenta de servicio
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
Listar workspaces de una cuenta de servicio
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Quitar workspace de cuenta de servicio
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizaciónUsuarios

Listar usuarios
GET/v1/organizations/users
Obtener usuario
GET/v1/organizations/users/{user_id}
Actualizar usuario
POST/v1/organizations/users/{user_id}
Quitar usuario
DELETE/v1/organizations/users/{user_id}

BetaOrganizaciónEspacios de trabajo

Listar workspaces
GET/v1/organizations/workspaces
Crear workspace
POST/v1/organizations/workspaces
Obtener workspace
GET/v1/organizations/workspaces/{workspace_id}
Actualizar workspace
POST/v1/organizations/workspaces/{workspace_id}
Archivar workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizaciónEspacios de trabajoLímites de velocidad

Listar límites de velocidad de un workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizaciónEspacios de trabajoMiembros

Listar miembros de workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Crear miembro de workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Obtener miembro de workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Actualizar miembro de workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Eliminar miembro de workspace
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizaciónEspacios de trabajoCuentas de servicio

Listar miembros de workspace de cuentas de servicio
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Crear miembro de workspace de cuenta de servicio
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Obtener miembro de workspace de cuenta de servicio
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Actualizar miembro de workspace de cuenta de servicio
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Eliminar miembro de workspace de cuenta de servicio
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizaciónLímites de velocidad

Listar límites de velocidad de la organización
GET/v1/organizations/rate_limits

BetaOrganizaciónConfiguración de cumplimiento

Obtener configuración de cumplimiento
GET/v1/organizations/compliance_settings
Actualizar configuración de cumplimiento
POST/v1/organizations/compliance_settings