Skip to main content
PUT
Actualizar herramienta
Actualiza una herramienta. Envía siempre su toolType actual y agrega solo los campos que quieras cambiar. No uses esta operación para convertirla a otro tipo.

Endpoint

Si actualizas una herramienta HTTP y envías details, incluye el objeto completo con endpoint, method y authentication. Para run_code, details debe incluir code. En todos los tipos, details reemplaza el objeto anterior; incluye los valores que quieras conservar.

Ejemplo de solicitud

details.authentication.token es un secreto. Usa un placeholder en ejemplos y protégelo con el mismo cuidado que una credencial.
Consulta Tipos de herramienta para conocer los campos específicos de cada toolType.

Respuesta exitosa (200)

Devuelve la herramienta actualizada con su configuración completa, incluidos tenantId, deleted, createdAt y lastUpdatedAt.
La respuesta no redacta tokens, headers ni código. Trátala como un secreto.

Errores frecuentes

Authorizations

x-ib-api-key
string
header
required

Path Parameters

toolId
string
required

Identificador de la herramienta.

Body

application/json
toolType
string
required
Allowed value: "http"
name
string
Minimum string length: 1
apiName
string

No uses el nombre reservado endTurn.

Minimum string length: 1
instructions
string
Minimum string length: 1
inputs
object[]
loadingText
string
showLoadingText
boolean
details
object

Si actualizas la configuración HTTP, envía el objeto completo.

storeOutputAsVariable
boolean
outputVariableName
string
outputVariablePath
string

Response

Herramienta actualizada.

Configuración completa de una herramienta. Las respuestas HTTP y de código no se redactan: pueden contener tokens, headers y código.

name
string
required

Nombre visible de la herramienta.

Minimum string length: 1
apiName
string
required

Nombre que el agente usa para llamar la herramienta.

Minimum string length: 1
instructions
string
required

Explica al agente cuándo y para qué debe usarla.

Minimum string length: 1
toolType
string
required
Allowed value: "http"
details
object
required
id
string
required

Identificador de la herramienta.

tenantId
string
required

Identificador asociado a la herramienta.

createdAt
number
required

Fecha de creación en milisegundos desde epoch.

lastUpdatedAt
number
required

Fecha de la última actualización en milisegundos desde epoch.

inputs
object[]
loadingText
string

Texto que puedes mostrar mientras se ejecuta la herramienta.

showLoadingText
boolean

Indica si se muestra loadingText durante la ejecución.

storeOutputAsVariable
boolean

Indica si la respuesta se guarda como variable de sesión.

outputVariableName
string

Nombre de la variable donde se guarda la respuesta.

outputVariablePath
string

Ruta con notación de puntos para extraer una parte de la respuesta JSON.

deleted
boolean

Estado de eliminación lógica. Las operaciones de lectura omiten herramientas eliminadas.