Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Update Tool

Update tool that is available in the workspace.

patch/v1/convai/tools/{tool_id}

Path parameters

tool_idstring required

ID of the requested tool.

ID of the requested tool.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

Example request

{
  "tool_config": {
    "response_timeout_secs": 20,
    "type": "webhook"
  }
}

Response

Successful Response

idstring required

Example response

{
  "tool_config": {
    "response_timeout_secs": 20,
    "type": "webhook"
  },
  "access_info": {
    "access_source": "creator",
    "creator_email": "john.doe@example.com",
    "creator_name": "John Doe",
    "is_creator": true,
    "role": "admin"
  }
}