# FormantAI | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.formantai.com/_mcp/server

## Docs

- [Overview](https://docs.formantai.com/overview.md): Build, launch, and operate production voice agents with FormantAI.
- [Quickstart](https://docs.formantai.com/quickstart.md): Make your first FormantAI Voice call and retrieve the result.
- [Create your first agent](https://docs.formantai.com/getting-started/create-agent.md): Configure, test, and prepare a FormantAI voice agent for production calls.
- [Authentication](https://docs.formantai.com/authentication.md): Authenticate API requests with FormantAI Voice API keys.
- [Core Concepts](https://docs.formantai.com/core-concepts.md): The resource model behind FormantAI Voice integrations.
- [Agents](https://docs.formantai.com/platform/agents.md): Configure the AI voice worker that handles calls.
- [Conversation stages](https://docs.formantai.com/platform/stages.md): Design structured voice flows with stages, transitions, tools, and retry resume points.
- [Tools](https://docs.formantai.com/platform/tools.md): Let agents call your APIs or execute structured actions.
- [Knowledge Base](https://docs.formantai.com/platform/knowledge-base.md): Ground voice agent responses in your business content.
- [Providers](https://docs.formantai.com/platform/providers.md): Understand the AI, speech, voice, and telephony providers that power FormantAI agents.
- [Telephony](https://docs.formantai.com/platform/telephony.md): Connect phone numbers and telephony providers for inbound and outbound voice agents.
- [Batch Calls](https://docs.formantai.com/platform/batch-calls.md): Run outbound campaigns from CSV files.
- [Launch a Batch Campaign](https://docs.formantai.com/guides/launch-batch-campaign.md): Upload a CSV and run outbound calls at scale.
- [Production checklist](https://docs.formantai.com/getting-started/production-checklist.md): Prepare FormantAI Voice integrations for reliable production traffic.
- [Conversations](https://docs.formantai.com/platform/conversations.md): Review call history, transcripts, recordings, and results.
- [Retrieve Call Results](https://docs.formantai.com/guides/retrieve-call-results.md): Fetch transcripts, structured outputs, and recordings after calls complete.
- [Receive Call Updates](https://docs.formantai.com/guides/receive-call-updates.md): Build a webhook receiver for real-time call outcomes.
- [Webhooks Overview](https://docs.formantai.com/webhooks/overview.md): Receive real-time call lifecycle events from FormantAI Voice.
- [Configure Webhooks](https://docs.formantai.com/webhooks/configure-webhooks.md): Add webhook targets to an agent from the dashboard.
- [Webhook Events](https://docs.formantai.com/webhooks/events.md): Event types FormantAI sends to webhook targets.
- [Webhook Payloads](https://docs.formantai.com/webhooks/payloads.md): Detailed webhook JSON payload examples and field descriptions.
- [Signature Verification](https://docs.formantai.com/webhooks/signature-verification.md): Verify FormantAI webhook requests with HMAC-SHA256.
- [Delivery & Retries](https://docs.formantai.com/webhooks/delivery-retries.md): Understand webhook timeout, retry, and idempotency behavior.
- [Make Your First Call](https://docs.formantai.com/guides/make-your-first-call.md): A practical end-to-end guide for starting and checking one outbound call.
- [API Overview](https://docs.formantai.com/api-reference/overview.md): Understand FormantAI Voice REST API structure, auth, resources, and usage patterns.
- [Make a Call](https://docs.formantai.com/api-reference/make-call.md): Start one outbound call with a configured FormantAI Voice agent.
- [Batch Calls](https://docs.formantai.com/api-reference/batch-calls.md): Upload CSV campaigns and inspect batch call performance.
- [Conversations](https://docs.formantai.com/api-reference/conversations.md): Retrieve call history, transcripts, structured results, and recordings.
- [Transcription](https://docs.formantai.com/api-reference/transcription.md): Submit audio files for asynchronous transcription.
- [Podcast](https://docs.formantai.com/api-reference/podcast.md): Render source material into a multi-speaker audio episode and download the finished MP3 or MP4.
- [Text to Speech](https://docs.formantai.com/api-reference/text-to-speech.md): Voice a batch of texts with ElevenLabs, Sarvam, Smallest or Vakyam and download one audio clip per text.
- [Decision Generation](https://docs.formantai.com/api-reference/decision-generation.md): Run a managed prompt over your input and get back a JSON decision in the shape you need.
- [Errors & Rate Limits](https://docs.formantai.com/api-reference/errors-rate-limits.md): Handle API errors, rate limits, idempotency, and concurrency limits.

## API Docs

- FormantAI Voice API > Calls [Make an outbound call](https://docs.formantai.com/api-reference/formant-ai-voice-api/calls/create-call.md)
- FormantAI Voice API > Batch Calls [Create a batch call](https://docs.formantai.com/api-reference/formant-ai-voice-api/batch-calls/create-batch-call.md)
- FormantAI Voice API > Batch Calls [List batch calls](https://docs.formantai.com/api-reference/formant-ai-voice-api/batch-calls/list-batch-calls.md)
- FormantAI Voice API > Batch Calls [Get a batch call](https://docs.formantai.com/api-reference/formant-ai-voice-api/batch-calls/get-batch-call.md)
- FormantAI Voice API > Batch Calls [Get batch metrics](https://docs.formantai.com/api-reference/formant-ai-voice-api/batch-calls/get-batch-call-metrics.md)
- FormantAI Voice API > Conversations [List conversations](https://docs.formantai.com/api-reference/formant-ai-voice-api/conversations/list-conversations.md)
- FormantAI Voice API > Conversations [Get a conversation](https://docs.formantai.com/api-reference/formant-ai-voice-api/conversations/get-conversation.md)
- FormantAI Voice API > Conversations [Download conversation recording](https://docs.formantai.com/api-reference/formant-ai-voice-api/conversations/get-conversation-recording.md)
- FormantAI Voice API > Transcription [Submit transcription job](https://docs.formantai.com/api-reference/formant-ai-voice-api/transcription/submit-transcription-job.md)
- FormantAI Voice API > Transcription [Get transcription job](https://docs.formantai.com/api-reference/formant-ai-voice-api/transcription/get-transcription-job.md)
- FormantAI Voice API > Podcast [Submit an episode from text](https://docs.formantai.com/api-reference/formant-ai-voice-api/podcast/submit-podcast.md)
- FormantAI Voice API > Podcast [Create a PDF upload URL](https://docs.formantai.com/api-reference/formant-ai-voice-api/podcast/create-podcast-upload.md)
- FormantAI Voice API > Podcast [Submit an episode from an uploaded PDF](https://docs.formantai.com/api-reference/formant-ai-voice-api/podcast/submit-podcast-from-pdf.md)
- FormantAI Voice API > Podcast [Get an episode](https://docs.formantai.com/api-reference/formant-ai-voice-api/podcast/get-podcast-job.md)
- FormantAI Voice API > Text to Speech [Submit a text-to-speech batch](https://docs.formantai.com/api-reference/formant-ai-voice-api/text-to-speech/submit-tts-batch.md)
- FormantAI Voice API > Text to Speech [Get a text-to-speech batch](https://docs.formantai.com/api-reference/formant-ai-voice-api/text-to-speech/get-tts-batch.md)
- FormantAI Voice API > Decision Generation [Generate a decision](https://docs.formantai.com/api-reference/formant-ai-voice-api/decision-generation/create-decision.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.formantai.com/openapi.json)
- [OpenAPI YAML](https://docs.formantai.com/openapi.yaml)