Verbex Docs home page

Dashboard
Dashboard

Custom Tools

Get custom tool

Documentation

API Reference

API Documentation

Getting an API Key

AI Agents v2

GET
List AI Agents
POST
Create AI Agent
GET
Get AI Agent
PUT
Update AI Agent
DEL
Delete AI Agent

Built-in Tools

GET
List built-in tools
POST
Create built-in tool
GET
Get built-in tool
PUT
Update built-in tool
DEL
Delete built-in tool

Custom Tools

GET
List custom tools
POST
Create custom tool
GET
Get custom tool
PUT
Update custom tool
DEL
Delete custom tool

Calls

POST
Create Web Call
GET
Create Web Call (Public Shared)
POST
Dial Outbound Phone Call
GET
Get Call
GET
List Calls

Post-call Analysis

GET
Get post-call analysis configuration for an agent
PUT
Update an existing post-call analysis configuration
POST
Create a new post-call analysis configuration
DEL
Delete an existing post-call analysis configuration
GET
Get Post Call Analysis Results

Phone Numbers

GET
Retrieve a paginated list of all phone numbers configured in your PIA Platform account
POST
Create a new phone number
GET
Retrieve detailed information about a specific phone number configuration
DEL
Remove a phone number configuration from the PIA Platform
PATCH
Update the configuration of an existing phone number

Knowledge Bases

GET
List Knowledge Bases
POST
Create Knowledge Base
GET
Get Knowledge Base
PUT
Update Knowledge Base
DEL
Delete Knowledge Base
GET
List Documents
POST
Add Document
DEL
Delete Document

Public Sharing

POST
Create Share
GET
Get Share
DEL
Delete Share

API Keys

GET
List API Keys
POST
Create API Key
GET
Get API Key
POST
Revoke API Key

Custom Tools

Get custom tool

Retrieve details of a specific custom tool.

GET

ai-agents

{ai_agent_id}

custom-tools

{tool_id}

Path Parameters

ai_agent_id

string

required

tool_id

string

required

Response

200 - application/json

additional_tool_info

object

required

Complete configuration for the custom tool including API details

additional_tool_info.api

object

required

Complete API configuration including endpoint, method, headers, and parameters

additional_tool_info.api.endpoint

string

required

The complete URL endpoint where the API requests will be sent (e.g., https://api.example.com/v1/resource)

additional_tool_info.api.headers

object

required

HTTP headers required for the API request, such as authentication tokens or content type specifications

additional_tool_info.api.headers.{key}

string

additional_tool_info.api.method

string

required

The HTTP method to be used for the API request (e.g., GET, POST, PUT, DELETE)

additional_tool_info.api.parameters

object

required

Configuration for both fixed and runtime parameters that will be used in API requests

additional_tool_info.api.parameters.fixed_params

object | null

Dictionary of parameters that remain constant across all API calls. Each parameter has a description and fixed value

additional_tool_info.api.parameters.fixed_params.{key}

object

additional_tool_info.api.parameters.runtime_params

object | null

Dictionary of parameters that must be provided at runtime. Each parameter has a description explaining its purpose

additional_tool_info.api.parameters.runtime_params.{key}

object

additional_tool_info.tool_type

enum<string>

default:

custom

Identifier specifying this is a custom tool implementation. Will always be set to 'custom'

Available options:

custom

created_at

string

required

Timestamp indicating when this custom tool was created

openai_tool

object

required

OpenAI function definition containing the tool's interface specification

openai_tool.description

string

required

openai_tool.name

string

required

openai_tool.parameters

object

required

openai_tool.parameters.properties

object

required

openai_tool.parameters.properties.{key}

object

openai_tool.parameters.properties.{key}.type

required

Available options:

string,

number,

integer,

boolean,

object,

array,

null

openai_tool.parameters.properties.{key}.additionalProperties

openai_tool.parameters.properties.{key}.default

any | null

openai_tool.parameters.properties.{key}.description

string | null

openai_tool.parameters.properties.{key}.enum

any[] | null

openai_tool.parameters.properties.{key}.format

string | null

openai_tool.parameters.properties.{key}.items

object | null

openai_tool.parameters.properties.{key}.maximum

number | null

openai_tool.parameters.properties.{key}.minimum

number | null

openai_tool.parameters.properties.{key}.properties

object | null

openai_tool.parameters.properties.{key}.required

string[] | null

openai_tool.parameters.additionalProperties

boolean | null

default:

false

openai_tool.parameters.required

string[] | null

openai_tool.parameters.type

enum<string>

default:

object

Available options:

object

updated_at

string

required

Timestamp indicating when this custom tool was last modified

tool_id

string

Unique identifier for the custom tool

Create custom tool Update custom tool

x github linkedin