Firetell Developer Documentation
Welcome to the Firetell Developer Platform (/docs/developers). Build programmable voice workflows, embed browser & mobile WebRTC softphones, orchestrate inbound/outbound call routing, and integrate real-time call telemetry into your CRM or backend stack.
Core Platform Pillars
| Pillar | Base Path / Package | Authentication | Primary Use Case |
|---|---|---|---|
| Getting Started | https://{workspace_id}.firetell.app/api/v1 | Authorization: ApiKey <token> | Platform architecture, authentication models, 5-minute quickstart, and SIP registration. |
| Workspace REST API | /api/v1/* | Authorization: ApiKey <token> | Server-to-server call control (/calls/make), composable actions[], DID numbers, SIP trunks, and Voice AI agents. |
| Agent Call Center API | /api/v1/call-center/* | Authorization: Bearer <jwt> (agent-api) | Agent softphone sessions, live call supervision (listen/whisper/barge), CDR history, and SMS threads. |
| Client In-App Calling API | /api/v1/client/* | Authorization: Bearer <jwt> (client-api) | End-user WebRTC audio/video calling and custom APNs/FCM VoIP push notifications. |
| Real-Time Webhooks | Customer HTTPS Endpoint | X-Webhook-Signature (HMAC-SHA256) | Low-latency event payloads for call.created, call.answered, call.ended, and AI summaries. |
| Client SDKs | @firetell/firetell-client-sdk / firetell_client_sdk | Client JWT (client-api) | Official JavaScript/TypeScript and Flutter SDKs for browser and native mobile calling. |
Quickstart: Trigger an Outbound Call in One Request
Initiate an outbound call and execute a sequence of composable voice actions (tts, connect_agent, connect_team, connect_voice_agent, play, ivr, recording, or stream) directly from your backend:
curl -X POST "https://{workspace_id}.firetell.app/api/v1/calls/make" \
-H "Authorization: ApiKey YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"from": {
"number": "+14155550199",
"name": "Customer Support"
},
"to": {
"number": "+14155552671",
"name": "John Doe"
},
"actions": [
{
"action": "tts",
"params": {
"text": "Hello from Firetell. Connecting you to your account specialist now.",
"voice": "en-US-tts-1",
"language": "en-US"
}
},
{
"action": "connect_agent",
"params": {
"agent_id": "agt_abc123",
"timeout": 30,
"ringback_audio_id": "aud_holdmusic"
}
}
]
}'
Explore by Section
- Introduction & Architecture → — Understand workspaces, extensions, DIDs, and calllegs.
- Authentication Guide → — Compare Workspace API Keys, Agent JWTs, and Client SDK JWTs.
- 5-Minute Quickstart → — Make your first programmatic call and inspect webhook events.
- Call Control API (
/calls/make) → — Full reference for outbound calling and all 10 composable action primitives. - Webhook Event Catalog → — Complete JSON schemas for call lifecycle, recording, and AI transcription events.
- Interactive Workspace API Playground → — Test OpenAPI 3.1 endpoints directly in your browser.