Beta

Models

AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 47 more

One of the following:

BetaAPIError object{ type: "api_error", message }

type: "api_error"

defaultapi_error

message: string

defaultInternal server error

BetaAuthenticationError object{ type: "authentication_error", message }

type: "authentication_error"

defaultauthentication_error

message: string

defaultAuthentication error

BetaBillingError object{ type: "billing_error", message }

type: "billing_error"

defaultbilling_error

message: string

defaultBilling error

BetaCurrency = "USD"

BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more

One of the following:

BetaErrorResponse object{ type: "error", error, request_id }

type: "error"

defaulterror

error: BetaError

One of the following:

request_id: string or null

BetaGatewayTimeoutError object{ type: "timeout_error", message }

type: "timeout_error"

defaulttimeout_error

message: string

defaultRequest timeout

BetaInvalidRequestError object{ type: "invalid_request_error", message }

type: "invalid_request_error"

defaultinvalid_request_error

message: string

defaultInvalid request

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{ type: "not_found_error", message }

type: "not_found_error"

defaultnot_found_error

message: string

defaultNot found

BetaOverloadedError object{ type: "overloaded_error", message }

type: "overloaded_error"

defaultoverloaded_error

message: string

defaultOverloaded

BetaPermissionError object{ type: "permission_error", message }

type: "permission_error"

defaultpermission_error

message: string

defaultPermission denied

BetaRateLimitError object{ type: "rate_limit_error", message }

type: "rate_limit_error"

defaultrate_limit_error

message: string

defaultRate limited

BetaModelos

Listar modelos

GET/v1/models

Lista los modelos disponibles.

Obtener un modelo

GET/v1/models/{model_id}

Obtiene un modelo específico.

BetaMensajes

Crear un mensaje

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

POST/v1/messages/count_tokens

Cuenta el número de tokens en un mensaje.

BetaMensajesLotes

Crear un lote de mensajes

POST/v1/messages/batches

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

Recuperar un lote de mensajes

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

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

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

DELETE/v1/messages/batches/{message_batch_id}

Elimina un lote de mensajes.

Recuperar resultados de un lote de mensajes

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

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

Crea un nuevo entorno con la configuración especificada.

Listar entornos

GET/v1/environments

Lista entornos con soporte de paginación.

Obtener entorno

GET/v1/environments/{environment_id}

Recupera un entorno específico por ID.

Actualizar entorno

POST/v1/environments/{environment_id}

Actualiza la configuración de un entorno existente.

Eliminar entorno

DELETE/v1/environments/{environment_id}

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

Archivar entorno

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

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

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

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

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

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

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

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

GET/v1/environments/{environment_id}/work/stats

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

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

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

Obtener versión de Skill

GET/v1/skills/{skill_id}/versions/{version}

Eliminar versión de Skill

DELETE/v1/skills/{skill_id}/versions/{version}

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

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

GET/v1/dreams

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

Obtener un Dream

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

POST/v1/dreams/{dream_id}/cancel

Detén un dream en estado pending o running.

Archivar un Dream

POST/v1/dreams/{dream_id}/archive

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