Quick Start

Create a VoxBridge account, copy your API key, and queue your first outbound AI voice call in under five minutes.

1. Create an account

Sign up at /signup with your company name, email, and password. VoxBridge provisions a new organization with 30 included minutes on the Starter plan, default inbound and outbound agents, and one live API key.

Alternatively, register programmatically:

curl -X POST https://voxbridge.cc/auth/signup \ -H "Content-Type: application/json" \ -d '{ "company_name": "Acme Lending", "full_name": "Jane Doe", "email": "jane@acme.com", "password": "your-secure-password" }'

The response includes api_key (shown once), access_token for the dashboard, and your organization details. Store the API key immediately — it cannot be retrieved later.

2. Save your API key

Live keys use the sk_live_ prefix. Authenticate all /v1/* requests with:

Authorization: Bearer sk_live_YOUR_KEY

Create additional keys or revoke compromised keys from the dashboard under Settings → API keys, or via POST /dashboard/api-keys with your dashboard JWT.

3. Configure your agent (optional)

Every organization starts with a default outbound agent (Welcome Call Agent) and an inbound support agent. Customize prompts and voice in the dashboard under Agents, or skip this step to use the defaults for your first call.

4. Set a webhook URL (recommended)

Point VoxBridge at your application endpoint to receive call.queued, call.ended, and call.analyzed events. Configure the URL in the dashboard or with PATCH /dashboard/webhook.

5. Queue your first outbound call

Send a POST to /v1/calls/outbound with the callee number and optional context variables for your agent prompt:

curl -X POST https://voxbridge.cc/v1/calls/outbound \ -H "Authorization: Bearer sk_live_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": "+15551234567", "client_name": "Jane Doe", "context": { "reference_number": "398690" }, "metadata": { "source": "onboarding_flow" } }'

A successful response returns HTTP 201 with a call object in queued status (or calling once telephony is configured). VoxBridge emits a call.queued webhook if a webhook URL is set.

6. Check call status

Poll the call by ID or list recent calls:

curl https://voxbridge.cc/v1/calls/CALL_UUID \ -H "Authorization: Bearer sk_live_YOUR_KEY" curl "https://voxbridge.cc/v1/calls?status=completed&limit=10" \ -H "Authorization: Bearer sk_live_YOUR_KEY"

What happens next

  • Phase 1 (current): Calls are persisted and webhooks fire; live dialing requires SIP configuration (see SIP & telephony).
  • Phase 2: Voice workers dial through your SIP trunk, run the agent conversation, and deliver transcripts via call.analyzed.

Next steps

Authentication → · Calls API → · Webhooks → · OpenAPI ↗