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 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"
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
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
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
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}
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}
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.

BetaTúneles

Crear túnel
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
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
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
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
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
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
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
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
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
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.

Obtener la organización actual
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
GET/v1/organizations/api_keys
Recuperar clave de API (Admin API)
GET/v1/organizations/api_keys/{api_key_id}

Recupera información sobre una única 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 gestió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 Claude Console.

Actualizar clave de API
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaciónClaves externas

Crear clave externa
POST/v1/organizations/external_keys

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

Listar claves externas
GET/v1/organizations/external_keys

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

Obtener clave externa
GET/v1/organizations/external_keys/{external_key_id}

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

Actualizar clave externa
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
DELETE/v1/organizations/external_keys/{external_key_id}

Elimina una configuración de clave externa.

Validar clave externa
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
POST/v1/organizations/federation_issuers

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/federation_issuers

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/federation_rules

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/federation_rules

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/federation_rules/{federation_rule_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/federation_rules/{federation_rule_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 workspace a regla de federación
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 workspaces de una regla de federación
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 workspace de regla de federación
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/invites

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

Listar invitaciones
GET/v1/organizations/invites

Lista las invitaciones de la organización.

Obtener invitación
GET/v1/organizations/invites/{invite_id}

Recupera una invitación por ID.

Eliminar invitación
DELETE/v1/organizations/invites/{invite_id}

Elimina una invitación pendiente.

BetaOrganizaciónCuentas de servicio

Crear cuenta de servicio
POST/v1/organizations/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
POST/v1/organizations/service_accounts/{service_account_id}/archive

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 workspace a cuenta de servicio
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 workspaces de una cuenta de servicio
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 workspace de cuenta de servicio
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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
GET/v1/organizations/users

Lista los miembros de la organización.

Obtener usuario
GET/v1/organizations/users/{user_id}

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

Actualizar usuario
POST/v1/organizations/users/{user_id}

Actualiza el rol de organización de un miembro.

Quitar usuario
DELETE/v1/organizations/users/{user_id}

Quita a un miembro de la organización.

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

Enumera los rate limits (límites de velocidad) de un espacio de trabajo.

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

Requiere un token de acceso OAuth con el alcance org:admin, obtenido con ant auth login --scope org:admin o mediante 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 miembro de workspace de cuenta de servicio
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requiere un token de acceso OAuth con el alcance org:admin, obtenido mediante ant auth login --scope org:admin o 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.

Obtener miembro de workspace de cuenta de servicio
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido mediante ant auth login --scope org:admin o 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.

Actualizar miembro de workspace de cuenta de servicio
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido mediante ant auth login --scope org:admin o 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.

Eliminar miembro de workspace de cuenta de servicio
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requiere un token de acceso OAuth con el alcance org:admin, obtenido mediante ant auth login --scope org:admin o 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

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

List Messages API rate limits for your organization.

BetaOrganizaciónConfiguración de cumplimiento

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

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

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

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

BetaOrganizaciónInforme de uso

Obtener informe de uso de Messages
GET/v1/organizations/usage_report/messages
Obtener informe de uso de Claude Code
GET/v1/organizations/usage_report/claude_code

Recupera métricas de uso agregadas diarias de los usuarios de Claude Code. Permite a las organizaciones analizar la productividad de los desarrolladores y crear paneles personalizados.

BetaOrganizaciónInforme de costos

Obtener informe de costos
GET/v1/organizations/cost_report

BetaOrganizaciónTúneles MCP

Listar túneles
Deprecated
GET/v1/organizations/tunnels

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará después de un período de migración. Las nuevas integraciones deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Obtener túnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará tras un período de migración. Las integraciones nuevas deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Archivar túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará tras un período de migración. Las integraciones nuevas deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Revelar token de túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará después de un período de migración. Las nuevas integraciones deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Rotar token de túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará después de un período de migración. Las nuevas integraciones deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

BetaOrganizaciónTúneles MCPCertificados de túnel

Crear certificado de túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará tras un período de migración. Las integraciones nuevas deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Listar certificados de túnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará después de un período de migración. Las nuevas integraciones deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Obtener certificado de túnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la Claude API y se eliminará tras un período de migración. Las integraciones nuevas deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

Archivar certificado de túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Obsoleto. Este endpoint de la Admin API ha sido reemplazado por /v1/tunnels en la API de Claude y se eliminará después de un período de migración. Las nuevas integraciones deben usar /v1/tunnels con el encabezado anthropic-beta: mcp-tunnels-2026-06-22 y un token WIF que incluya el alcance workspace:manage_tunnels. Las integraciones existentes siguen funcionando con el encabezado mcp-tunnels-2026-05-19 y el alcance org:manage_tunnels durante el período de migración.

BetaOrganizaciónAnalíticaSummaries

Obtener resúmenes de actividad
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

BetaOrganizaciónAnalíticaUsuarios

Listar actividad de usuarios
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
GET/v1/organizations/analytics/apps/chat/projects

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

BetaOrganizaciónAnalíticaConectores

Obtener uso de conectores
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
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
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
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
GET/v1/organizations/analytics/usage_report

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

BetaOrganizaciónAnalíticaUser Usage Report

Obtener uso de tokens por usuario
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
GET/v1/organizations/analytics/cost_report

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

BetaOrganizaciónAnalíticaUser Cost Report

Obtener costo por usuario
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
POST/v1/organizations/spend_limits

Establece un límite de gasto.

Obtener límite de gasto
GET/v1/organizations/spend_limits/{spend_limit_id}

Recupera un límite de gasto por ID.

Eliminar límite de gasto
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Elimina un límite de gasto.

List Spend Limits
GET/v1/organizations/spend_limits

List the organization's spend limits.

BetaOrganizaciónLímites de gastoEffective

Listar límites de gasto efectivos
GET/v1/organizations/spend_limits/effective

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

BetaOrganizaciónLímites de gastoSolicitudes de aumento

Listar solicitudes de aumento de límite de gasto
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
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
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
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
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
GET/v1/organizations/rbac_groups

Lista los grupos RBAC del tenant de Claude Enterprise.

Obtener grupo RBAC
GET/v1/organizations/rbac_groups/{rbac_group_id}

Recupera un grupo RBAC por ID.

Actualizar grupo RBAC
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
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
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Lista los miembros de un grupo RBAC.

Agregar miembro a un grupo RBAC
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 un grupo RBAC
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
GET/v1/organizations/rbac_roles

Lista los roles RBAC de la organización.

Obtener rol RBAC
GET/v1/organizations/rbac_roles/{rbac_role_id}

Recupera un rol RBAC por ID.

BetaOrganizaciónRoles RBACPermisos

Listar permisos de un rol RBAC
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

Lista los permisos que otorga un rol RBAC.

BetaOrganizaciónPlugins

Create Plugin
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

List Plugins
GET/v1/organizations/plugins

List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.

Delete Plugin
DELETE/v1/organizations/plugins/{plugin_id}

Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.

BetaOrganizaciónPluginsVersiones

Create Plugin Version
POST/v1/organizations/plugins/{plugin_id}/versions

Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.

List Plugin Versions
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download one version's .zip archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed.

BetaOrganizaciónPluginsInstallation Settings

List Plugin Installation Settings
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

BetaOrganizaciónPluginsShares

List Plugin Shares
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

BetaOrganizaciónPlugin Marketplaces

List Plugin Marketplaces
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.

Validate Plugin Marketplace Repository
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.