API Overview

View as Markdown

The FormantAI Voice API lets your backend initiate calls, launch batch campaigns, retrieve conversations, download recordings, and submit transcription jobs.

Base URL

https://api.voice.formantai.com

Regional environments:

RegionBase URL
Globalhttps://api.voice.formantai.com
Indiahttps://api.in.voice.formantai.com

Authentication

Use an API key as a bearer token.

1Authorization: Bearer YOUR_API_KEY

Resources

ResourceDescription
CallsStart one outbound call immediately or schedule one for later.
Batch CallsUpload CSV campaigns and inspect campaign metrics.
ConversationsRetrieve call history, transcripts, results, trace IDs, and recordings.
TranscriptionSubmit audio files for asynchronous transcription.
WebhooksReceive real-time terminal call events without polling.

Request formats

  • JSON endpoints require Content-Type: application/json.
  • File upload endpoints use multipart/form-data.
  • List endpoints use limit and offset pagination.
  1. Create an API key in the dashboard.
  2. Select or create an agent.
  3. Make one test call with POST /v1/call.
  4. Configure a webhook target on the agent.
  5. Fetch the completed conversation to confirm transcript, results, and recording.
  6. Add batch calls if your workflow needs campaigns.

Important IDs

IDWhere it comes fromWhere it is used
agent_idDashboard agent pageCalls, batch calls, conversation filters, webhook payloads
conversation_idConversation record or webhook payloadFetch details and recordings
trace_idPOST /v1/call responseDebugging and support
batch_idPOST /v1/batch-call responseFetch batch detail and metrics
event_idWebhook deliveryDedupe webhook processing

Next steps