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 v2
Prompt Generation
Public Sharing
{
"openai_tool": {
"name": "<string>",
"description": "<string>",
"parameters": {
"properties": {},
"type": "object",
"required": [
"<string>"
],
"additionalProperties": false
}
},
"additional_tool_info": {
"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": {}
}
},
"tool_type": "custom"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tool_id": "<string>",
"tool_start_message": "<string>",
"tool_delayed_message": "<string>",
"tool_complete_message": "<string>",
"tool_failed_message": "<string>"
}Get custom tool
Retrieve details of a specific custom tool.
{
"openai_tool": {
"name": "<string>",
"description": "<string>",
"parameters": {
"properties": {},
"type": "object",
"required": [
"<string>"
],
"additionalProperties": false
}
},
"additional_tool_info": {
"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": {}
}
},
"tool_type": "custom"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tool_id": "<string>",
"tool_start_message": "<string>",
"tool_delayed_message": "<string>",
"tool_complete_message": "<string>",
"tool_failed_message": "<string>"
}Response
Successful Response
OpenAI function definition containing the tool's interface specification
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null "object"Complete configuration for the custom tool including API details
Show child attributes
Show child attributes
Complete API configuration including endpoint, method, headers, and parameters
Show child attributes
Show child attributes
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)
Configuration for both fixed and runtime parameters that will be used in API requests
Show child attributes
Show child attributes
Dictionary of parameters that remain constant across all API calls. Each parameter has a description and fixed value
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Detailed explanation of what this fixed parameter represents and how it will be used
The actual value that will be used for this fixed parameter in API calls
Type of the parameter
Dictionary of parameters that must be provided at runtime. Each parameter has a description explaining its purpose
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Detailed explanation of what this runtime parameter represents and how it should be provided during API calls
Type of the parameter (e.g., string, number, boolean) that should be provided at runtime
Indicates whether this parameter must be provided at runtime. If true, the API call will fail without this parameter.
Default value to use if the parameter is not provided at runtime. Only applicable when required is False.
{
"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