AI Phone Agent Docs home page
Search...
⌘K
Ask AI
OpenAPI Definition
Examples
Pricing
Login
Login
Search...
Navigation
Documentation
API Reference
API Documentation
API Overview
Getting Started
Authentication
Authorization
GET
List tokens
POST
Create a token
DEL
Delete a token
GET
Generate one-time auth token
Agents
POST
Publish an Agent
POST
Revert an Agent
GET
List Agent Versions
POST
Create Named Version
POST
Replace Stored Version
POST
Restore Version to Agent
PUT
Rename Stored Version
POST
Update Agent
GET
Fetch Staging Agent
GET
Fetch Live Agent
GET
Get Agent
POST
Outbound Call from Agent
POST
Outbound SMS from Agent
Phone Numbers
POST
Assign phone number to your account
POST
Assign a BYO phone number
POST
Return / Unassign Phone Number
POST
Search for local numbers by locality
POST
Search for local numbers by prefix
POST
Search for local numbers by phrase
SIP
GET
List SIP IP Whitelist
POST
Add IP to SIP IP Whitelist
DEL
Remove IP from SIP IP Whitelist
GET
List SIP Outbound Routes
POST
Add SIP Outbound Route
DEL
Remove SIP Outbound Route
Messaging
GET
List Priority Inbox
GET
List Junk Inbox
GET
Fetch Recent Messages
GET
Fetch Room Messages
GET
Fetch Conversation
Webhooks
GET
List Webhooks
POST
Add Webhook
DEL
Remove Webhook
GET
List supported Webhook Relay types
GET
Get a webhook relay configuration
POST
Create or update a webhook relay
DEL
Delete a webhook relay configuration
GET
List all webhook relay configurations
Knowledge
GET
Fetch Context
POST
Add Context
Agent URLs
GET
Check agent url availability
GET
Fetch existing agent url
POST
Create agent url
Accounts
POST
Create a new reseller
GET
List resellers
POST
Create a new organization
DEL
Delete an organization
GET
List organizations
GET
List agent accounts
POST
Create a new account
DEL
Delete an account
GET
List admin users
DEL
Delete admin user
POST
Invite admin user
GET
Search accounts
GET
Fetch Account by externalAccountId
POST
Update Organization Settings
Billing
GET
View Usage
GET
View Offered Product Plan
GET
View Current Product Plan
GET
View Available Product Plans
POST
Provision Billing System Configuration
POST
Subscribe to product plan
GET
View Available Add Ons
GET
View Product Catalog
GET
Fetch a product plan details
POST
Configure ADR Export Settings
API Reference
GET
Get apiv2sipregistration
POST
Post apiv2sipregistration
DEL
Delete apiv2sipregistration
POST
Post apiv2agentzapierresponse
List agent inbox
Assistant
Responses are generated using AI and may contain mistakes.