---
sidebar_position: 1
title: Introduction
description: Introduction to the Firetell Developer Platform — Cloud Communications APIs for voice, calls, SIP, and AI.
---

# Introduction

Welcome to the **Firetell Developer Platform**. Firetell provides a suite of cloud communications APIs that enable you to build voice-powered applications, automate call workflows, and integrate intelligent voice agents into your products.

## What is Firetell?

Firetell is a **Communications Platform as a Service (CPaaS)** that offers:

- **Cloud Phone Numbers** — Provision and manage virtual phone numbers worldwide
- **Programmable Voice** — Make, receive, and control calls via API
- **Smart IVR / Call Flows** — Build drag-and-drop interactive voice response systems
- **SIP Trunking** — Connect your existing PBX infrastructure to the cloud
- **Call Center** — Manage agents, teams, queues, and call routing
- **Voice AI** — Deploy AI-powered voice agents for customer interactions
- **Call Recording** — Record and store call audio for compliance and quality assurance
- **Webhooks** — Receive real-time event notifications

## Who is this for?

This documentation is designed for **developers** who want to integrate Firetell's capabilities into their applications using our REST APIs, webhooks, and SDKs.

## Base URL

Each workspace has its own unique API domain. The base URL for all developer API requests follows this pattern:

```
https://{workspace_id}.firetell.app/api/v1
```

Replace `{workspace_id}` with your workspace's subdomain. To find it:

1. Log in to [Firetell Console](https://console.firetell.com)
2. Select your workspace
3. Go to **Workspace Settings** → **General**
4. Copy the **Domain** value

For example, if your domain is `yourcompany`, your base URL would be:

```
https://yourcompany.firetell.app/api/v1
```

## Workspaces & Regions

When you create a workspace, you select a **region** that determines where your data is stored and API requests are routed. Each workspace gets a unique subdomain (`{workspace_id}.firetell.app`) that is DNS-resolved to the regional server cluster.

### How It Works

```
Create workspace "companyA" with region ASIA-SOUTH1
                    │
                    ▼
  companyA.firetell.app  →  DNS  →  asia-south-1 cluster
                                     ├─ API servers
                                     ├─ Database
                                     ├─ Media servers
                                     ├─ Signaling servers
                                     └─ Storage servers

```

All API traffic, call data, recordings, and agent sessions for that workspace are processed and stored within the selected region.

### Available Regions

| Region            | ID               | Location      |
| ----------------- | ---------------- | ------------- |
| **ASIA-EAST1**    | `asia-east-1`    | Vietnam       |
| **ASIA-SOUTH1**   | `asia-south-1`   | Singapore     |
| **US-EAST1**      | `us-east-1`      | United States |
| **EUROPE-NORTH1** | `europe-north-1` | France        |

:::warning
The region **cannot be changed** after workspace creation. Choose the region closest to your users and agents for the lowest latency.
:::

:::note
**Need a custom domain?**

Enterprise customers can use their own domain (e.g., `api.yourcompany.com`) instead of `*.firetell.app`. Contact [enterprise@firetell.com](mailto:enterprise@firetell.com) for details.
:::

## Call Center Portal

Every workspace comes with a **ready-to-use Call Center Portal** that your agents can use immediately — no development required.

### Access Points

| Platform    | URL / App                                                                 | Description                      |
| ----------- | ------------------------------------------------------------------------- | -------------------------------- |
| **Web**     | `https://{workspace_id}.firetell.app`                                     | Browser-based agent portal       |
| **iOS**     | [App Store](https://apps.apple.com/app/firetell)                          | Native iOS app with VoIP push    |
| **Android** | [Google Play](https://play.google.com/store/apps/details?id=com.firetell) | Native Android app with FCM push |

Agents log in with their username and password to make/receive calls, manage their availability, chat with team members, and more.

### Built on the Same API

The Call Center Portal is built entirely on the **same public API** documented here. This means:

- Everything the portal does, **your app can do too**
- The portal serves as a **reference implementation** of the API
- You can build your own custom agent experience using the same endpoints

### Open Source

The Call Center Portal source code is available on GitHub:

| Repository | Platform | Description |
| ---------- | -------- | ----------- |
| [firetell-call-center-web](https://github.com/firetellcom/firetell-call-center-web) | Web | Browser-based portal (Angular) |
| [firetell-call-center-app](https://github.com/firetellcom/firetell-call-center-app) | iOS, Android | Mobile app (Flutter) |
| — | Windows, macOS | Desktop app *(coming soon)* |

You can fork and customize these apps to match your brand, add custom features, or use them as a starting point for your own agent application.

## Authentication

Firetell APIs support authentication using either a server-side **API Key** or a client-side **JWT Token**.

### API Key (Server)

Used for backend/server-to-server integrations.

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

### JWT Token (Client)

Used for client-side applications (such as WebRTC or mobile SDKs) to authenticate agents or clients securely.

```bash
curl -X GET "https://{workspace_id}.firetell.app/api/v1/phone-numbers" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
```

See the [Authentication](/docs/getting-started/authentication) guide and [Client Authentication](/docs/sdks/javascript/authentication) guide for more details.

## Next Steps

- [Authentication](/docs/getting-started/authentication) — Learn how to authenticate API requests
- [Quickstart](/docs/getting-started/quickstart) — Make your first API call
- [API Reference](/docs/rest-api/overview) — Explore all available endpoints