For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Skip to navigation

API Reference System

API health check

GET

/healthz

GET

/healthz

curl https://api.voicebip.com/healthz

200Retrieved

{
  "status": "ok"
}

Response

Healthy

statusstringOptional

Was this page helpful?

Documentation Integrations API Reference

API Reference

Exchange an API key for a short-lived JWT
API health check
Create a new user account and workspace
Confirm a signup verification token
Exchange email + password for a JWT
Request a password reset email
Consume a reset token and set a new password
Get authenticated user and workspace
Revoke all active sessions
Permanently delete user account
List agent templates
List agents
Create an agent
Get an agent
Delete an agent
Update an agent
Toggle shareable flag on an agent
Export agent conversations
Chat with an agent (text mode)
List available AI models
List API keys
Create an API key
Revoke an API key
Rotate an API key
List available numbers
List numbers owned by the workspace
Provision a number
Claim the first available number matching criteria
Get a number
Release a number
Reclaim a quarantined number
List calls in the workspace
Initiate an outbound call
Get call details
End a call
Get call recording audio
Put a call on hold
Resume a held call
Transfer a call to another number
Inject DTMF tones into a call
Stream real-time call events via WebSocket
Stream real-time call transcript via SSE
List available TTS voice IDs
List campaigns in the workspace
Create a campaign
Get a campaign
Start a campaign
Pause a running campaign
Resume a paused campaign
Cancel a campaign
Retry a campaign's failed recipients
List a campaign's targets
Add recipients to a campaign
Get workspace analytics
List routing rules
Create a routing rule
Update a routing rule
Delete a routing rule
Public shareable agent landing-page metadata
WebRTC signaling for shareable agent links
Mint a scoped token for a browser call
Submit a WebRTC SDP offer for an authenticated browser call
Send a message (SMS or WhatsApp)
Send a WhatsApp template message
Get a single message
Get conversation with message history
Transition a conversation's AI mode
Stream real-time conversation events via SSE
Send a test webhook event
List webhook delivery attempts
Get a single webhook delivery
Re-drive events from the webhook dead-letter queue
List webhook endpoints for an agent
Register a new webhook endpoint
Delete a webhook endpoint
Enable or disable a webhook endpoint
Get usage for current billing period
Get workspace prepaid balance
Initiate a Paystack payment to top up balance
Stripe payment webhook (signature-verified, no auth)
Accept the NDPR Data Processing Agreement
Check DPA acceptance status
Erase all PII for a phone number (NDPR right to erasure)
Get the caller's workspace
Permanently delete the workspace
Update workspace settings
Rotate the workspace HMAC signing secret
Get the caller workspace's active subscription
Change the subscription plan (tier switch with proration)
List WhatsApp and SMS conversations in the workspace
List knowledge bases
Create a knowledge base
Get a knowledge base
Delete a knowledge base (soft delete)
Update a knowledge base
List documents in a knowledge base
Add a document to a knowledge base
Get a document
Delete a document (chunks + object, recompute counts)
Finalize a file upload and start ingestion
Retrieve relevant chunks from a knowledge base (BYOM)