API Reference
Built-in Tools
Custom Tools
Calls
Post-call Analysis
Phone Numbers
- GETRetrieve a paginated list of all phone numbers configured in your PIA Platform account
- POSTCreate a new phone number
- GETRetrieve detailed information about a specific phone number configuration
- DELRemove a phone number configuration from the PIA Platform
- PATCHUpdate the configuration of an existing phone number
Knowledge Bases
Knowledge Bases v2
Prompt Generation
Public Sharing
List custom tools
List custom tools with pagination.
{
"tools": [
{
"tool_id": "<string>",
"tool_start_message": "<string>",
"tool_delayed_message": "<string>",
"tool_complete_message": "<string>",
"tool_failed_message": "<string>",
"openai_tool": {
"description": "Get the delivery date for a customer's order",
"name": "get_delivery_date",
"parameters": {
"additionalProperties": false,
"properties": {
"order_id": {
"description": "The customer's order ID",
"type": "string"
}
},
"required": [
"order_id"
],
"type": "object"
}
},
"additional_tool_info": {
"tool_type": "custom",
"api": {
"endpoint": "https://api.example.com/test",
"headers": {
"Content-Type": "application/json"
},
"method": "POST",
"parameters": {
"fixed_params": {
"api_key": {
"description": "API key for authentication",
"value": "test-api-key"
}
},
"runtime_params": {}
}
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_page_token": "<string>"
}Path Parameters
Query Parameters
1 <= x <= 100Response
List of custom tools matching the request criteria
OpenAI function definition containing the tool's interface specification
"object"{
"description": "Get the delivery date for a customer's order",
"name": "get_delivery_date",
"parameters": {
"additionalProperties": false,
"properties": {
"order_id": {
"description": "The customer's order ID",
"type": "string"
}
},
"required": ["order_id"],
"type": "object"
}
}
Complete configuration for the custom tool including API details
Complete API configuration including endpoint, method, headers, and parameters
The complete URL endpoint where the API requests will be sent (e.g., https://api.example.com/v1/resource)
The HTTP method to be used for the API request (e.g., GET, POST, PUT, DELETE)
HTTP headers required for the API request, such as authentication tokens or content type specifications
Configuration for both fixed and runtime parameters that will be used in API requests
Dictionary of parameters that remain constant across all API calls. Each parameter has a description and fixed value
Dictionary of parameters that must be provided at runtime. Each parameter has a description explaining its purpose
{
"endpoint": "https://api.example.com/test",
"headers": { "Content-Type": "application/json" },
"method": "POST",
"parameters": {
"fixed_params": {
"api_key": {
"description": "API key for authentication",
"value": "test-api-key"
}
},
"runtime_params": {}
}
}
Identifier specifying this is a custom tool implementation. Will always be set to 'custom'
"custom"Timestamp indicating when this custom tool was created
Timestamp indicating when this custom tool was last modified
Unique identifier for the custom tool
Optional message to display when the tool is started
Optional message to display when the tool is delayed
Optional message to display when the tool is completed
Optional message to display when the tool fails
Token to retrieve the next page of results, null if no more results available
{
"tools": [
{
"tool_id": "<string>",
"tool_start_message": "<string>",
"tool_delayed_message": "<string>",
"tool_complete_message": "<string>",
"tool_failed_message": "<string>",
"openai_tool": {
"description": "Get the delivery date for a customer's order",
"name": "get_delivery_date",
"parameters": {
"additionalProperties": false,
"properties": {
"order_id": {
"description": "The customer's order ID",
"type": "string"
}
},
"required": [
"order_id"
],
"type": "object"
}
},
"additional_tool_info": {
"tool_type": "custom",
"api": {
"endpoint": "https://api.example.com/test",
"headers": {
"Content-Type": "application/json"
},
"method": "POST",
"parameters": {
"fixed_params": {
"api_key": {
"description": "API key for authentication",
"value": "test-api-key"
}
},
"runtime_params": {}
}
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_page_token": "<string>"
}