Skip to main content
LLM ReadyRaw Markdown for AI agents:quickstart.mdFull index:llms.txtllms-full.txt

Quickstart

Get up and running with the Firetell API in just a few minutes.

Prerequisites​

Step 1: Find Your Workspace Domain​

Each workspace has its own regional domain ({workspace_id}.{regional_domain}) based on the region chosen when the workspace was created (see Workspaces & Regions). To find yours:

  1. Log in to Firetell Console
  2. Select your workspace
  3. Go to Workspace Settings → General
  4. Note the Domain value (e.g., yourcompany.firetell.vn, yourcompany.firetell.asia, yourcompany.firetell.us, yourcompany.eu.firetell.com, or yourcompany.firetell.app)

Your API base URL will be:

https://{workspace_id}.{regional_domain}/api/v1
tip

In the examples below, replace {workspace_id}.firetell.app with your full workspace regional domain ({workspace_id}.{regional_domain}).

Step 2: List Phone Numbers​

Verify your API key works by listing the phone numbers in your workspace:

curl -X GET "https://{workspace_id}.firetell.app/api/v1/phone-numbers" \
-H "Authorization: ApiKey YOUR_API_KEY"

Response:

{
"data": [
{
"id": "pn_a1b2c3d4e5f6g7h8i9j0k1",
"title": "Main Number",
"number": "14155550100",
"country_code": "US",
"dial_code": "1",
"status": "active",
"type": "local",
"capabilities": ["voice"],
"provider": "sip_trunk",
"enable_outbound": true,
"inbound_acl_id": "acl_abc123",
"outbound_gateway_id": "gw_def456",
"call_flow_id": "cf_ghi789",
"shared_teams_id": [],
"record_outbound": true,
"fee_per_month": 0,
"fee_per_mins_call": 0,
"created_at": "2026-01-15T08:30:00.000Z",
"updated_at": "2026-01-15T08:30:00.000Z"
}
],
"meta": {
"total": 1,
"page": 1,
"limit": 20,
"total_pages": 1
}
}

Step 3: Make a Call​

Initiate an outbound call and execute actions when answered:

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": "+14155550100",
"name": "Customer Support"
},
"to": {
"number": "+12125550123",
"name": "John Doe"
},
"actions": [
{
"action": "connect_agent",
"params": {
"agent_id": "agt_abc123",
"timeout": 30
}
}
]
}'

Response:

{
"data": {
"call_id": "call_abc123",
"status": "created",
"direction": "outbound",
"from": {
"name": "Customer Support",
"number": "+14155550100"
},
"to": {
"name": "John Doe",
"number": "+12125550123"
},
"job_id": "job_xyz789",
"job_status": "queued"
}
}

What's Next?​

Now that you've made your first API call, explore the full capabilities: