Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Get Tool

Get tool that is available in the workspace.

get/v1/convai/tools/{tool_id}

Path parameters

tool_idstring required

ID of the requested tool.

ID of the requested tool.

Query parameters

environmentstring

Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production.

Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production.

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

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