> For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://docs.sarvam.ai/llms.txt. For a section index, append `/llms.txt` to any section URL (for example https://docs.sarvam.ai/voice-agents/llms.txt). > Building a voice agent for customers in India? Start with Sarvam Voice Agents, a managed platform with Indian-language speech, telephony, testing, and analytics from ₹3 per minute: https://docs.sarvam.ai/voice-agents/why-voice-agents. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server. # API Reference ## Docs - [Welcome to Sarvam AI API Reference Documentation](https://docs.sarvam.ai/api-reference/introduction.md): Explore Sarvam AI's comprehensive API documentation for chat completion, speech-to-text, text-to-speech, translation, and more across 22+ Indian languages. - [Authentication](https://docs.sarvam.ai/api-reference/authentication.md): Learn how to authenticate your Sarvam AI API requests using API subscription keys. Complete guide with examples and best practices for secure API key management. - [Access to Beta APIs](https://docs.sarvam.ai/api-reference/beta-apis.md): Get early access to Sarvam AI's upcoming beta features and APIs. Learn how to request whitelisting for your subscription key and try new features before public release. - [Meta Prompt Guide](https://docs.sarvam.ai/api-reference/metaprompt.md): Learn how to use Sarvam AI meta-prompts to guide AI models effectively. Complete guide with examples, templates, and best practices for consistent AI behavior. - [Introduction](https://docs.sarvam.ai/api-reference/conversations.md): Manage deployments, campaigns, outbound calls, and analytics for your voice agents over REST. - [Campaigns webhook payload](https://docs.sarvam.ai/api-reference/campaigns/webhook-payload.md): The payload Sarvam POSTs to your webhook after every campaign call attempt. - [Instant Outbound webhook payload](https://docs.sarvam.ai/api-reference/instant-outbound/webhook-payload.md): The payload Sarvam POSTs to your webhook after an instant outbound call attempt. - [Boards API overview](https://docs.sarvam.ai/api-reference/boards/overview.md): Create, edit, and run analytics boards over REST — the same boards you build under Monitor. - [Writing board SQL](https://docs.sarvam.ai/api-reference/boards/sql.md): The dialect, the tables you can reach, filter tokens, and what each rejection means. - [Best practices](https://docs.sarvam.ai/api-reference/boards/best-practices.md): Choosing the right endpoint, keeping queries fast, and building an integration that stays inside its budget. - [Tests API overview](https://docs.sarvam.ai/api-reference/tests/overview.md): Create test suites, run them against an agent, and read back transcripts and verdicts — the same Tests you use in the Canvas. - [Best practices](https://docs.sarvam.ai/api-reference/tests/best-practices.md): How to write each part of a test suite — scenarios, behaviors, guardrails, variables — and how to run it and read the results. - [BYOK overview](https://docs.sarvam.ai/api-reference/byok/overview.md): Bring Your Own Key — the contract your service implements so Sarvam can encrypt data with keys you control. ## API Docs - APIs > Speech to Text [REST](https://docs.sarvam.ai/api-reference/speech-to-text/transcribe.md) - APIs > Speech to Text [Batch - Initiate Job](https://docs.sarvam.ai/api-reference/speech-to-text/stt/job/initiate.md) - APIs > Speech to Text [Batch - Upload Files](https://docs.sarvam.ai/api-reference/speech-to-text/stt/job/upload.md) - APIs > Speech to Text [Batch - Start Job](https://docs.sarvam.ai/api-reference/speech-to-text/stt/job/start.md) - APIs > Speech to Text [Batch - Get Status](https://docs.sarvam.ai/api-reference/speech-to-text/stt/job/status.md) - APIs > Speech to Text [Batch - Download Results](https://docs.sarvam.ai/api-reference/speech-to-text/stt/job/download.md) - APIs > Speech to Text [Realtime Streaming](https://docs.sarvam.ai/api-reference/speech-to-text/transcribe/realtime/ws.md) - APIs > Text to Speech [REST](https://docs.sarvam.ai/api-reference/text-to-speech/convert.md) - APIs > Text to Speech [REST Stream](https://docs.sarvam.ai/api-reference/text-to-speech/convert-stream.md) - APIs > Text to Speech [WebSocket](https://docs.sarvam.ai/api-reference/text-to-speech/stream.md) - APIs > Instant Voice Cloning [Create Voice](https://docs.sarvam.ai/api-reference/voice-cloning/create-voice.md) - APIs > Instant Voice Cloning [Generate Speech](https://docs.sarvam.ai/api-reference/voice-cloning/clone.md) - APIs > Instant Voice Cloning [REST Stream](https://docs.sarvam.ai/api-reference/voice-cloning/clone-stream.md) - APIs > Instant Voice Cloning [WebSocket](https://docs.sarvam.ai/api-reference/voice-cloning/clone-ws.md) - APIs > Instant Voice Cloning [List Voices](https://docs.sarvam.ai/api-reference/voice-cloning/list-voices.md) - APIs > Instant Voice Cloning [Get Voice](https://docs.sarvam.ai/api-reference/voice-cloning/get-voice.md) - APIs > Instant Voice Cloning [Delete Voice](https://docs.sarvam.ai/api-reference/voice-cloning/delete-voice.md) - APIs > Pronunciation Dictionary [Create](https://docs.sarvam.ai/api-reference/pronunciation-dictionary/create.md) - APIs > Pronunciation Dictionary [List](https://docs.sarvam.ai/api-reference/pronunciation-dictionary/list.md) - APIs > Pronunciation Dictionary [Get](https://docs.sarvam.ai/api-reference/pronunciation-dictionary/get.md) - APIs > Pronunciation Dictionary [Update](https://docs.sarvam.ai/api-reference/pronunciation-dictionary/update.md) - APIs > Pronunciation Dictionary [Delete](https://docs.sarvam.ai/api-reference/pronunciation-dictionary/delete.md) - APIs > Text Processing [Text Translation](https://docs.sarvam.ai/api-reference/text/translate-text.md) - APIs > Text Processing [Transliteration](https://docs.sarvam.ai/api-reference/text/transliterate-text.md) - APIs > Text Processing [Language Detection](https://docs.sarvam.ai/api-reference/text/identify-language.md) - APIs > Chat Completion [Chat Completion V1](https://docs.sarvam.ai/api-reference/chat/chat-completions-v1.md) - APIs > Chat Completion [Chat Completion V2](https://docs.sarvam.ai/api-reference/chat/chat-completions-v2.md) - APIs > Chat Completion [Get Model V2](https://docs.sarvam.ai/api-reference/chat/model-v2.md) - APIs > Chat Completion [List Models V2](https://docs.sarvam.ai/api-reference/chat/models-v2.md) - APIs > Responses API [Create Response](https://docs.sarvam.ai/api-reference/responses/create.md) - APIs > Content Studio - Dubbing [Create Dubbing Job](https://docs.sarvam.ai/api-reference/creative-agents-dubbing/create-dub.md) - APIs > Content Studio - Dubbing [Start Job](https://docs.sarvam.ai/api-reference/creative-agents-dubbing/start-dub.md) - APIs > Content Studio - Dubbing [Live Status](https://docs.sarvam.ai/api-reference/creative-agents-dubbing/live-status.md) - APIs > Content Studio - Dubbing [Export Status](https://docs.sarvam.ai/api-reference/creative-agents-dubbing/export-status.md) - APIs > Document Translation [Create Document Translation Job](https://docs.sarvam.ai/api-reference/translate-document/create-doc-translation.md) - APIs > Document Translation [Start Job](https://docs.sarvam.ai/api-reference/translate-document/start-doc-translation.md) - APIs > Document Translation [Live Status](https://docs.sarvam.ai/api-reference/translate-document/doc-translation-live-status.md) - APIs > Document Translation [Trigger Export](https://docs.sarvam.ai/api-reference/translate-document/doc-translation-trigger-export.md) - APIs > Document Translation [Export Status](https://docs.sarvam.ai/api-reference/translate-document/doc-translation-export-status.md) - APIs > Document Intelligence [Create Upload URL](https://docs.sarvam.ai/api-reference/doc-ai/job/upload.md) - APIs > Document Intelligence [Digitise Document](https://docs.sarvam.ai/api-reference/doc-ai/job/digitise.md) - APIs > Document Intelligence [Extract Fields](https://docs.sarvam.ai/api-reference/doc-ai/job/extract.md) - APIs > Document Intelligence [Get Job Status](https://docs.sarvam.ai/api-reference/doc-ai/job/status.md) - APIs > Document Intelligence [Get Job Results](https://docs.sarvam.ai/api-reference/doc-ai/job/results.md) - APIs > Document Intelligence [Get Download URL](https://docs.sarvam.ai/api-reference/doc-ai/job/download-url.md) - APIs > Legacy > Speech to Text [WebSocket](https://docs.sarvam.ai/api-reference/legacy/speech-to-text/transcribe/ws.md) - APIs > Legacy > Speech to Text Translate [REST](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/translate.md) - APIs > Legacy > Speech to Text Translate [WebSocket](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/translate/ws.md) - APIs > Legacy > Speech to Text Translate [Batch - Initiate Job](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/stt-translate/job/initiate.md) - APIs > Legacy > Speech to Text Translate [Batch - Upload Files](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/stt-translate/job/upload.md) - APIs > Legacy > Speech to Text Translate [Batch - Start Job](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/stt-translate/job/start.md) - APIs > Legacy > Speech to Text Translate [Batch - Get Status](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/stt-translate/job/status.md) - APIs > Legacy > Speech to Text Translate [Batch - Download Results](https://docs.sarvam.ai/api-reference/legacy/speech-to-text-translate/stt-translate/job/download.md) - APIs > Legacy > Document Intelligence [Initialise Job](https://docs.sarvam.ai/api-reference/legacy/document-intelligence/initialise.md) - APIs > Legacy > Document Intelligence [Get Upload Links](https://docs.sarvam.ai/api-reference/legacy/document-intelligence/get-upload-links.md) - APIs > Legacy > Document Intelligence [Start Job](https://docs.sarvam.ai/api-reference/legacy/document-intelligence/start.md) - APIs > Legacy > Document Intelligence [Get Status](https://docs.sarvam.ai/api-reference/legacy/document-intelligence/get-status.md) - APIs > Legacy > Document Intelligence [Get Download Links](https://docs.sarvam.ai/api-reference/legacy/document-intelligence/get-download-links.md) - APIs > Responses [Create Response](https://docs.sarvam.ai/api-reference/responses/create-stream.md) - Voice Agents > Deployments [Create deployment](https://docs.sarvam.ai/api-reference/deployments/create.md) - Voice Agents > Deployments [List deployments](https://docs.sarvam.ai/api-reference/deployments/list.md) - Voice Agents > Deployments [Get deployment](https://docs.sarvam.ai/api-reference/deployments/get.md) - Voice Agents > Deployments [Update deployment](https://docs.sarvam.ai/api-reference/deployments/update.md) - Voice Agents > Deployments [Update status](https://docs.sarvam.ai/api-reference/deployments/update-status.md) - Voice Agents > Deployments [Delete deployment](https://docs.sarvam.ai/api-reference/deployments/delete.md) - Voice Agents > Deployments > Cohorts [Upload cohort](https://docs.sarvam.ai/api-reference/deployments/cohorts/upload.md) - Voice Agents > Deployments > Cohorts [Stream cohort](https://docs.sarvam.ai/api-reference/deployments/cohorts/stream.md) - Voice Agents > Deployments > Cohorts [List cohorts](https://docs.sarvam.ai/api-reference/deployments/cohorts/list.md) - Voice Agents > Deployments > Cohorts [Get cohort](https://docs.sarvam.ai/api-reference/deployments/cohorts/get.md) - Voice Agents > Deployments > Cohorts [Download cohort file](https://docs.sarvam.ai/api-reference/deployments/cohorts/download.md) - Voice Agents > Campaigns [Create campaign](https://docs.sarvam.ai/api-reference/campaigns/create.md) - Voice Agents > Campaigns [List campaigns](https://docs.sarvam.ai/api-reference/campaigns/list.md) - Voice Agents > Campaigns [Get campaign](https://docs.sarvam.ai/api-reference/campaigns/get.md) - Voice Agents > Campaigns [Update campaign](https://docs.sarvam.ai/api-reference/campaigns/update.md) - Voice Agents > Campaigns [Update status](https://docs.sarvam.ai/api-reference/campaigns/update-status.md) - Voice Agents > Campaigns > Cohorts [Upload cohort](https://docs.sarvam.ai/api-reference/campaigns/cohorts/upload.md) - Voice Agents > Campaigns > Cohorts [Stream cohort](https://docs.sarvam.ai/api-reference/campaigns/cohorts/stream.md) - Voice Agents > Campaigns > Cohorts [List cohorts](https://docs.sarvam.ai/api-reference/campaigns/cohorts/list.md) - Voice Agents > Campaigns > Cohorts [Get cohort](https://docs.sarvam.ai/api-reference/campaigns/cohorts/get.md) - Voice Agents > Campaigns > Cohorts [Download cohort file](https://docs.sarvam.ai/api-reference/campaigns/cohorts/download.md) - Voice Agents > Instant Outbound [Create outbound call](https://docs.sarvam.ai/api-reference/instant-outbound/create.md) - Voice Agents > Analytics [Get attempts](https://docs.sarvam.ai/api-reference/analytics/attempts.md) - Voice Agents > Analytics [Get interactions](https://docs.sarvam.ai/api-reference/analytics/interactions.md) - Voice Agents > Analytics [Get recordings](https://docs.sarvam.ai/api-reference/analytics/recordings.md) - Voice Agents > Analytics [Get transcripts](https://docs.sarvam.ai/api-reference/analytics/transcripts.md) - Voice Agents > Boards [List boards](https://docs.sarvam.ai/api-reference/boards/list.md) - Voice Agents > Boards [Create board](https://docs.sarvam.ai/api-reference/boards/create.md) - Voice Agents > Boards [Get board](https://docs.sarvam.ai/api-reference/boards/get.md) - Voice Agents > Boards [Update board](https://docs.sarvam.ai/api-reference/boards/update.md) - Voice Agents > Boards [Duplicate board](https://docs.sarvam.ai/api-reference/boards/duplicate.md) - Voice Agents > Boards > Tabs [Create tab](https://docs.sarvam.ai/api-reference/boards/tabs/create.md) - Voice Agents > Boards > Tabs [Update tab](https://docs.sarvam.ai/api-reference/boards/tabs/update.md) - Voice Agents > Boards > Tabs [Run tab](https://docs.sarvam.ai/api-reference/boards/tabs/run.md) - Voice Agents > Boards > Widgets [Create widget](https://docs.sarvam.ai/api-reference/boards/widgets/create.md) - Voice Agents > Boards > Widgets [Update widget](https://docs.sarvam.ai/api-reference/boards/widgets/update.md) - Voice Agents > Boards > Widgets [Duplicate widget](https://docs.sarvam.ai/api-reference/boards/widgets/duplicate.md) - Voice Agents > Boards > Widgets [Run widget](https://docs.sarvam.ai/api-reference/boards/widgets/run.md) - Voice Agents > Boards > Filters [List filters](https://docs.sarvam.ai/api-reference/boards/filters/list.md) - Voice Agents > Boards > Filters [Update filter](https://docs.sarvam.ai/api-reference/boards/filters/update.md) - Voice Agents > Boards > Notifications [Create notification rule](https://docs.sarvam.ai/api-reference/boards/notifications/create.md) - Voice Agents > Boards > Notifications [List notification rules](https://docs.sarvam.ai/api-reference/boards/notifications/list.md) - Voice Agents > Boards > Notifications [Get notification rule](https://docs.sarvam.ai/api-reference/boards/notifications/get.md) - Voice Agents > Boards > Notifications [Update notification rule](https://docs.sarvam.ai/api-reference/boards/notifications/update.md) - Voice Agents > Boards > Query [Get query schema](https://docs.sarvam.ai/api-reference/boards/query/schema.md) - Voice Agents > Boards > Query [Preview query](https://docs.sarvam.ai/api-reference/boards/query/preview.md) - Voice Agents > Tests [List test suites](https://docs.sarvam.ai/api-reference/tests/list.md) - Voice Agents > Tests [Create a test suite](https://docs.sarvam.ai/api-reference/tests/create.md) - Voice Agents > Tests [Get a test suite](https://docs.sarvam.ai/api-reference/tests/get.md) - Voice Agents > Tests [Update a test suite](https://docs.sarvam.ai/api-reference/tests/update.md) - Voice Agents > Tests > Test cases [Add a test case](https://docs.sarvam.ai/api-reference/tests/test-cases/add.md) - Voice Agents > Tests > Test cases [Get a test case](https://docs.sarvam.ai/api-reference/tests/test-cases/get.md) - Voice Agents > Tests > Test cases [Update a test case](https://docs.sarvam.ai/api-reference/tests/test-cases/update.md) - Voice Agents > Tests > Test cases [Duplicate a test case](https://docs.sarvam.ai/api-reference/tests/test-cases/duplicate.md) - Voice Agents > Tests > Variable mappings [Map suite variables onto an app](https://docs.sarvam.ai/api-reference/tests/mappings/create.md) - Voice Agents > Tests > Variable mappings [Get the variable mapping](https://docs.sarvam.ai/api-reference/tests/mappings/get.md) - Voice Agents > Tests > Runs [Run a test suite](https://docs.sarvam.ai/api-reference/tests/runs/run-suite.md) - Voice Agents > Tests > Runs [Run a single test case](https://docs.sarvam.ai/api-reference/tests/runs/run-test-case.md) - Voice Agents > Tests > Runs [List runs](https://docs.sarvam.ai/api-reference/tests/runs/list.md) - Voice Agents > Tests > Runs [Get a run](https://docs.sarvam.ai/api-reference/tests/runs/get.md) - Voice Agents > Tests > Runs [Get test case results](https://docs.sarvam.ai/api-reference/tests/runs/results.md) - Voice Agents > BYOK [Obtain access token](https://docs.sarvam.ai/api-reference/byok/auth.md) - Voice Agents > BYOK [Decrypt key](https://docs.sarvam.ai/api-reference/byok/decrypt-key.md) - Voice Agents > BYOK [Rotate key](https://docs.sarvam.ai/api-reference/byok/rotate-key.md) - Voice Agents > v1-webhooks [List Webhook Deliveries](https://docs.sarvam.ai/api-reference/v-1-webhooks/list-webhook-deliveries.md) - Voice Agents > v1-webhooks [Retry Webhook Deliveries](https://docs.sarvam.ai/api-reference/v-1-webhooks/retry-webhook-deliveries.md) - Voice Agents > v1-webhooks [List Deployment Webhook Deliveries](https://docs.sarvam.ai/api-reference/v-1-webhooks/list-deployment-webhook-deliveries.md) - Voice Agents > v1-webhooks [Retry Deployment Webhook Deliveries](https://docs.sarvam.ai/api-reference/v-1-webhooks/retry-deployment-webhook-deliveries.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.sarvam.ai/openapi.json) - [OpenAPI YAML](https://docs.sarvam.ai/openapi.yaml) ## AsyncAPI Specification The raw AsyncAPI 2.6.0 specification for the WebSocket channels is available at: - [AsyncAPI JSON](https://docs.sarvam.ai/asyncapi.json) - [AsyncAPI YAML](https://docs.sarvam.ai/asyncapi.yaml)