Verbex Docs

API Reference

Dashboard

Creating Your Own Verbex AI Voice Assistant 

Learn how to build and manage intelligent AI voice assistants with Verbex Platform

Getting Started

Creating AI agents

Configure Your Verbex Agent

Configure Post Call Analysis

Configuring Advanced Settings

Test Your Configured Assistant

Connect Your Verbex Agents

Test Your Verbex Agents

Monitoring And Analysis

Frequently Asked Questions

How to get an API key for Verbex Platform

Getting an API Key

List AI Agents

Create a new AI agent with the provided configuration.

Create AI Agent

Get AI Agent

Update AI Agent

Delete AI Agent

List built-in tools

Create a new built-in tool with the provided configuration.

Create built-in tool

Retrieve details of a specific built-in tool.

Get built-in tool

Update built-in tool

Delete built-in tool

List custom tools

Create a new custom tool with the provided configuration.

Create custom tool

Retrieve details of a specific custom tool.

Get custom tool

Update custom tool

Delete custom tool

Create a new web-based call session with an AI agent.

This endpoint initializes a new web call session that allows direct browser-based 
communication between a user and an AI agent. Use this for implementing click-to-call 
or embedded chat interfaces in web applications.

Create Web Call

Create a web call session using a public shared link.

This endpoint enables creating web calls without user authentication, using a shared key instead.
Ideal for public-facing applications where users don't need accounts to interact with AI agents.

Create Web Call (Public Shared)

Initiate an outbound phone call from an AI agent to a specified phone number.

This endpoint triggers the AI agent to place a phone call to the provided number.
Use this for scenarios where the AI needs to proactively contact users via phone.

Dial Outbound Phone Call

Retrieve detailed information about a specific call by its ID.

This endpoint provides comprehensive information about any call (web or phone) 
including its current status, duration, and associated metadata.

Get Call

Retrieve a paginated list of calls with optional filtering and sorting.

This endpoint allows querying call history with various filters including time ranges
and specific AI agents. Results are paginated for efficient data retrieval.

List Calls

Get post-call analysis configuration for an agent

Update an existing post-call analysis configuration

Create a new post-call analysis configuration

Delete the existing post-call analysis configuration for a specific AI agent.

Delete an existing post-call analysis configuration

Retrieve detailed post-call analysis results for a specific call.

Get Post Call Analysis Results

Retrieve a paginated list of all phone numbers configured in your PIA Platform account.
The list includes all phone number types (Import Phone Numbers and PIA-managed) and their current
configurations. Use the page_size and page_token parameters to navigate through the list
for accounts with many phone numbers.

The response includes essential information for each phone number:
- Phone number details and type
- Associated AI agent (if any)
- Configuration status
- Creation and last modified timestamps

Retrieve a paginated list of all phone numbers configured in your PIA Platform account

Create and configure a new phone number in the PIA Platform. This endpoint supports two phone number types:

- Import Phone Numbers (SIP) for custom SIP trunk integration
- PIA-managed phone numbers (provided by our platform)

The phone number will be validated and configured based on the provided settings. The created phone
number can then be associated with AI agents to handle inbound and outbound calls.

Create a new phone number

Retrieve detailed information about a specific phone number configuration. The response includes:

- Phone number details and type (Import Phone Number or PIA-managed)
- Associated AI agent information if the number is linked
- SIP trunk configuration for Import Phone Numbers
- Routing rules and dispatch configurations

Retrieve detailed information about a specific phone number configuration

Remove a phone number configuration from the PIA Platform. This action:

- Removes the phone number from your PIA Platform account
- Disconnects any AI agent associations
- Cleans up SIP trunk configurations for Import Phone Numbers
- Removes routing rules and dispatch configurations

Remove a phone number configuration from the PIA Platform

Update the configuration of an existing phone number. This endpoint allows you to:

- Modify the AI agent association
- Update SIP trunk settings for Import Phone Numbers
- Adjust routing rules and call handling preferences
- Update metadata and labels

Update the configuration of an existing phone number

Retrieves a paginated list of all knowledge bases accessible to the authenticated user. The results
can be paginated using the page_size and page_token parameters. This endpoint is useful for discovering
and managing multiple knowledge bases, with each entry including basic metadata about the knowledge base.

List Knowledge Bases

Creates a new knowledge base for storing and managing documents. A knowledge base serves as a container 
for related documents that can be used by AI agents for context and information retrieval. Each knowledge 
base is isolated and can have its own set of documents, making it ideal for organizing domain-specific 
knowledge.

Create Knowledge Base

Retrieves detailed information about a specific knowledge base, including its metadata, configuration,
and statistics. This endpoint is useful for checking the current state of a knowledge base, including
the number of documents it contains and its last update timestamp.

Get Knowledge Base

Updates the configuration and metadata of an existing knowledge base. This allows you to modify 
properties such as the name, description, or any custom settings associated with the knowledge base
while preserving its documents and relationships.

Update Knowledge Base

Permanently deletes a knowledge base and all its associated documents. This action cannot be undone,
and all documents, embeddings, and metadata associated with the knowledge base will be removed from
the system. Ensure you have backed up any important data before deletion.

Delete Knowledge Base

Retrieves a paginated list of all documents within a specific knowledge base. Each document entry
includes metadata such as the document type, processing status, creation timestamp, and other relevant
information. This endpoint is useful for monitoring document status and managing the contents of a
knowledge base.

List Documents

Adds a new document to the specified knowledge base. Supports two types of documents:
1. Files (PDFs, Word documents, etc.) - Upload document files directly
2. Websites - Provide a URL for automatic crawling and content extraction

The document processing happens asynchronously in the background. The API immediately returns
a processing status and document ID, while the actual document processing, text extraction,
and vector embedding generation continue in the background.

Add Document

Removes a specific document from the knowledge base. This operation deletes both the document's
content and its associated vector embeddings from the system. The deletion is permanent and cannot
be undone. The knowledge base itself remains intact, only the specified document is removed.

Delete Document

Enables you to make an AI agent available to the users who has access to a shared key. 

Ideal for integrating AI agents into public-facing websites where user authentication isn't required,
such as landing pages, help centers, or public knowledge bases. This allows website visitors to
interact with your AI agent without needing to create an account or log in. The shared key will be stored in the website.

Create Share

Retrieves the shared key and configuration that enables an AI agent to be available to users.

Get Share

Removes the shared key and configuration that enables an AI agent to be available to users. The AI agent will no longer be accessible using the shared key.

Get Started

Create

Configure

Connect

Test

Monitor

FAQs

Creating Your Own Verbex AI Voice Assistant

Create

Configure

Connect

Deploy

Monitor

Get Started

Create

Configure

Connect

Test

Monitor

FAQs

Create

Configure

Connect

Deploy

Monitor

​

​

​

​

​