Get Tool By ID - TIXAE Agents

Documentation

Discord

API Reference

API Documentation

Get Started

V3

Get Started
📁 Workspaces
🤖 Agents
Calls & Numbers
🔨 Tools
✖️ Variables
👥 Leads
🧠 Knowledge Base

Agents

Workspaces

GET

tools

{toolId}

curl --request GET \
  --url https://eu-voiceglow-runtime-vbmbkqccuq-ey.a.run.app/v3/tools/{toolId} \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "data": {
    "isDefault": true,
    "method": "GET",
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "disabled": true,
    "isVapiTool": true,
    "vapiId": "<string>",
    "isGlobal": true,
    "variablesIds": [
      "<string>"
    ],
    "agentId": "<string>",
    "userId": "<string>",
    "backchannellingPhrases": [
      "<string>"
    ],
    "fields": [
      {
        "id": "<string>",
        "in": "<string>",
        "type": "string",
        "value": "<any>",
        "defaultValue": "<any>",
        "key": "<string>",
        "description": "<string>",
        "required": true,
        "reusable": true,
        "isEnv": true,
        "isSystem": true,
        "isGlobal": true,
        "agentId": "<string>",
        "userId": "<string>"
      }
    ],
    "channels": [
      "web-chat"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

toolId

string

required

Response

200

application/json

Successful response

success

boolean

required

message

string

required

data

object

required

data.id

string

required

A unique identifier for the tool. Ensures distinct identification within the system.

data.name

string

required

The name of the tool, providing a human-readable identifier for display purposes.

data.description

string

required

A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.

data.isDefault

boolean

Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.

data.method

enum<string>

The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.

Available options:

GET,

POST,

PUT,

PATCH

data.serverUrl

string

The server URL where the tool's operations are performed. Used for network-based integrations.

data.serverUrlSecret

string

A secret token or key associated with the server URL. Provides secure access to the tool's backend services.

data.createdAt

string

The timestamp when the tool was created, formatted as an ISO 8601 string. Useful for tracking tool lifecycle.

data.updatedAt

string

The timestamp when the tool was last updated, formatted as an ISO 8601 string. Useful for versioning and auditing.

data.disabled

boolean

Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.

data.isVapiTool

boolean

Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.

data.vapiId

string

A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.

data.isGlobal

boolean

If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.

data.variablesIds

string[]

An array of variable IDs associated with the tool. Each ID maps to a specific variable used by the tool.

data.agentId

string

The unique identifier of the agent associated with this tool. Helps in linking the tool to a specific agent.

data.userId

string

The unique identifier of the user associated with this tool. Used for user-specific configurations and access control.

data.backchannellingPhrases

string[]

An array of phrases used for backchannel communication. These phrases help in maintaining conversational flow.

data.fields

object[]

data.fields.id

string

required

A unique identifier for the field, ensuring it is distinct across the system.

data.fields.in

string

Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.

data.fields.type

enum<string>

Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.

Available options:

string,

number,

boolean,

system

data.fields.value

any

The current assigned value of the field. This value is optional and supports any type depending on the field's context.

data.fields.defaultValue

any

A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.

data.fields.key

string

The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.

data.fields.description

string

A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.

data.fields.required

boolean

Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.

data.fields.reusable

boolean

Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.

data.fields.isEnv

boolean

Specifies if this field represents an environment variable, typically used for configuration or deployment.

data.fields.isSystem

boolean

Indicates whether this field is a system-level variable, reserved for core operations or internal use.

data.fields.isGlobal

boolean

If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.

data.fields.agentId

string

References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.

data.fields.userId

string

References the unique identifier of the user associated with this field. Useful for user-specific customizations.

data.channels

enum<string>[]

The channels that the tool can be used on.

Available options:

web-chat,

whatsapp,

instagram,

telegram,

discord,

gb-chat,

vapi,

messenger,

voice,

telephony

Get Tools Delete Tool

curl --request GET \
  --url https://eu-voiceglow-runtime-vbmbkqccuq-ey.a.run.app/v3/tools/{toolId} \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "data": {
    "isDefault": true,
    "method": "GET",
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "disabled": true,
    "isVapiTool": true,
    "vapiId": "<string>",
    "isGlobal": true,
    "variablesIds": [
      "<string>"
    ],
    "agentId": "<string>",
    "userId": "<string>",
    "backchannellingPhrases": [
      "<string>"
    ],
    "fields": [
      {
        "id": "<string>",
        "in": "<string>",
        "type": "string",
        "value": "<any>",
        "defaultValue": "<any>",
        "key": "<string>",
        "description": "<string>",
        "required": true,
        "reusable": true,
        "isEnv": true,
        "isSystem": true,
        "isGlobal": true,
        "agentId": "<string>",
        "userId": "<string>"
      }
    ],
    "channels": [
      "web-chat"
    ]
  }
}