Update a tool

put

https://api.indigitall.com/v2/pathbot/{appId}/tools/{toolId}

Updates the configuration of a tool by its unique tool ID.

Path Params

appId

int64

required

The id of the application to retrieve tools from.

toolId

int64

required

The id of the tool to retrieve.

Body Params

toolTypeCode

string

enum

The code of the tool type.

Allowed:

config

object

Configuration settings for the general tool, stored as JSON. This can include a 'custom output' key with a string value. For specific catalog tools like 'Contact Center' or 'Dialogflow' (identified by catalog_id), this 'config' field is mandatory and must contain a 'custom output' key with a non-empty string value. This validation is performed by the service.

name

string

Name of the tool configuration.

description

string

Description of the tool configuration.

humanReview

boolean

Flag indicating if human review is required for this tool's output.

reviewMessage

string | null

Message to display if human review is triggered.

reviewKeyword

string | null

Keyword to approve the agent actions.

argsSchema

object | null

JSON schema for the tool's arguments, defining expected input parameters.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update a tool

400The request could not be understood or was missing required parameters.

401Authentication failed or user does not have permissions for the desired action.

403The server understood the request, but refuses to authorize it.

404The requested resource could not be found.

500The server encountered an unexpected condition that prevented it from fulfilling the request.

defaultAn unexpected error occurred.