Built-in Tools
List built-in tools
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
Built-in Tools
List built-in tools
List built-in tools with pagination.
GET
/
v2
/
ai-agents
/
{ai_agent_id}
/
builtin-tools
{
"tools": [
{
"tool_id": "<string>",
"tool_start_message": "<string>",
"tool_delayed_message": "<string>",
"tool_complete_message": "<string>",
"tool_failed_message": "<string>",
"tool_description": "<string>",
"tool_name": "send_email",
"from_email": "<string>",
"app_password": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_page_token": "<string>"
}
Path Parameters
Response
200
application/json
Successful Response
List of built-in tools configured for the AI agent
Email address configured as sender
Application-specific password used for authentication
Timestamp when the tool was created
Timestamp when the tool was last updated
Unique identifier of the email 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
Description of the email tool's purpose and configuration
Identifier for the email tool type
Allowed value:
"send_email"
Token for retrieving 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>",
"tool_description": "<string>",
"tool_name": "send_email",
"from_email": "<string>",
"app_password": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_page_token": "<string>"
}