Skip to content
Voicebot
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Content mode
Release
Debug
Getting started
What Voicebot is
Your first automated call
Concepts
Overview
Object model
Identity and access
Glossary
Integration guide
Integration overview
Phase 1 — Infrastructure and connection
Phase 2 — API integration
Phase 3 — Configuration
Account access for your customers
Monitoring and results
Account API
Overview
Scenario
Overview
List scenarios
Create scenario
Get scenario
Delete scenario
Update scenario
Copy scenario
List scenario placeholders
Run a webhook brick configuration
List system variables
ScenarioVersion
Overview
List scenario versions
Get a scenario version by its natural key
Delete the WIP draft record by its natural key
Agent
Overview
List agents
Create agent
Get agent
Delete agent
Update agent
Archive agent
Number
Overview
List Numbers
Create Number
Get Number
Delete Number
Update Number
NumberPool
Overview
List Number pools
Create Number pool
Get Number pool
Delete Number pool
Update Number pool
Audio
Overview
Upload audio file
Get audio file (proxied or presigned link)
SMS
Overview
List SMS providers
Create SMS provider
Get SMS provider
Delete SMS provider
Update SMS provider
List alphas
List numbers
Send SMS
Communication
Overview
List communications
Create communication (agent-dialed, or a scenario test call)
Get communication
Delete communication
Get call-history (proxied or presigned link)
Get call recording (proxied or presigned link)
Get speech-recognition recording (proxied or presigned link)
CommunicationResult
Overview
List result deliveries
Get result delivery
Update result delivery
Resend a result delivery
Auth
Overview
Login
Consume magic link
Change password
Consume password reset
Logout
User
Overview
List users
Create user
Get user
Delete user
Update user
Request user magic link
Request user password reset
Profile
Overview
Get own profile
Update own profile
Info
Overview
List countries
List regions
LLM Adapter
Overview
Download a RAG document file
Upload a RAG document for an account
Delete a RAG document for an account
Get chat stream info
Poll chat stream result
List available models
List RAG documents for an account
Semantic search over an account's RAG documents
Chat completion (RAG-capable)
Start a RAG-augmented chat stream
Commit or cancel a chat stream
Create text embeddings
TTS Adapter
Overview
Synthesize speech (query params)
Synthesize speech (JSON body)
Drop the cached audio
Prime the synthesis cache
List languages
Normalize a synthesis URL
List voices
Resolve a voice
Classifier
Overview
Save classifier content
Delete a classifier
List an account's classifier versions
Create a classifier
Get one version
Classify a phrase against one version
Entity
Overview
List entity types per language
Extract entities from a phrase
Model
Overview
List models
STT Adapter
Overview
Run an STT engine over audio sources
List recognition languages
List recognition model options
List tuning options per engine and language
List STT dictionaries
Create an STT dictionary
Get an STT dictionary
Delete an STT dictionary
Update an STT dictionary
Tenant API
Overview
LB
Overview
Least-loaded hermes hosts
Live hermes node objects
Ranked node snapshot
Resolve
Overview
Resolve an inbound call to its run envelope
Account
Overview
List accounts
Create account
Get account
Delete account
Update account
Issue account API key
Tenant
Overview
List tenants
Create tenant
Get tenant
Delete tenant
Update tenant
Issue tenant API key
FeatureFlag
Overview
List a tenant's feature-flag rules
Update one feature-flag rule
Trunk
Overview
List trunks
Create trunk
Get trunk
Delete trunk
Update trunk
STTDictionary
Overview
List STT dictionaries
Create STT dictionary
Get STT dictionary
Delete STT dictionary
Update STT dictionary
SMSInternal
Overview
Send an SMS for a communication
Select theme
Dark
Light
Auto
Content mode
Release
Debug
Overview
Profile
Section titled “Profile”
Authenticated caller’s own user + account. Self-service, no path id.
Operations
Section titled “Operations”
GET
/v1/profile
PATCH
/v1/profile