Vida Docs home page
Search or ask...
Login
OpenAPI Definition
Examples
Pricing
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
Agents
POST
Publish an agent
POST
Revert an agent
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
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
Messaging
GET
List priority inbox
GET
List junk inbox
GET
Fetch recent messages
GET
Fetch room messages
Webhooks
GET
List webhooks
POST
Add webhook
DEL
Remove webhook
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
GET
List organizations
GET
List agent accounts
POST
Create a new account
GET
List admin users
DEL
Delete admin user
POST
Invite admin user
Billing
GET
View usage
GET
View current product plan
GET
View available product plans
Webhooks
List webhooks
GET
https://api.vida.dev
/
api
/
v2
/
webhooks
Send
Server
baseUrl
string
baseUrl
string
Production API Root
Authorization
token
string
*
token
Required
string
Vida API Token
Authorizations
token
string
query
required
Vida API Token
Response
200 - application/json
success
boolean
message
string
webhooks
object[]
Show child attributes
Fetch room messages
Add webhook