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
Custom Tools
Update custom tool
Update an existing custom tool.
PUT
/
v2
/
ai-agents
/
{ai_agent_id}
/
custom-tools
/
{tool_id}
Copy
{
"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"
}
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Copy
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.