API Overview
The FormantAI Voice API lets your backend initiate calls, launch batch campaigns, retrieve conversations, download recordings, and submit transcription jobs.
Base URL
Regional environments:
Authentication
Use an API key as a bearer token.
Resources
Request formats
- JSON endpoints require
Content-Type: application/json. - File upload endpoints use
multipart/form-data. - List endpoints use
limitandoffsetpagination.
Recommended integration order
- Create an API key in the dashboard.
- Select or create an agent.
- Make one test call with
POST /v1/call. - Configure a webhook target on the agent.
- Fetch the completed conversation to confirm transcript, results, and recording.
- Add batch calls if your workflow needs campaigns.