Sign in
Agents Platform

Delete Tool

Delete tool from the workspace.

delete/v1/convai/tools/{tool_id}

Path parameters

tool_idstring required

ID of the requested tool.

ID of the requested tool.

Query parameters

forceboolean

If set to true, the tool will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents and branches.

If set to true, the tool will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents and branches.

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.

Response

Successful Response

{"stackTrail":"paths:/v1/convai/tools/{tool_id}:delete:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 28 revisions of this API.