> 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

- [Introduction](https://docs.sarvam.ai/voice-agents/api/introduction.md): Manage deployments, campaigns, outbound calls, and analytics for your voice agents over REST.
- [Deployments webhook payload](https://docs.sarvam.ai/voice-agents/api/deployments/webhooks/webhook-payload.md): The payload Sarvam POSTs to your webhook after each inbound call finishes.
- [Campaigns webhook payload](https://docs.sarvam.ai/voice-agents/api/campaigns/webhooks/webhook-payload.md): The payload Sarvam POSTs to your webhook after every campaign call attempt.
- [Instant Outbound webhook payload](https://docs.sarvam.ai/voice-agents/api/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/voice-agents/api/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/voice-agents/api/boards/sql.md): The dialect, the tables you can reach, filter tokens, and what each rejection means.
- [Best practices](https://docs.sarvam.ai/voice-agents/api/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/voice-agents/api/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/voice-agents/api/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/voice-agents/api/byok/overview.md): Bring Your Own Key — the contract your service implements so Sarvam can encrypt data with keys you control.

## API Docs

- API Reference > Deployments [Create deployment](https://docs.sarvam.ai/voice-agents/api/deployments/create.md)
- API Reference > Deployments [List deployments](https://docs.sarvam.ai/voice-agents/api/deployments/list.md)
- API Reference > Deployments [Get deployment](https://docs.sarvam.ai/voice-agents/api/deployments/get.md)
- API Reference > Deployments [Update deployment](https://docs.sarvam.ai/voice-agents/api/deployments/update.md)
- API Reference > Deployments [Update status](https://docs.sarvam.ai/voice-agents/api/deployments/update-status.md)
- API Reference > Deployments [Delete deployment](https://docs.sarvam.ai/voice-agents/api/deployments/delete.md)
- API Reference > Deployments > Webhooks [List webhook deliveries](https://docs.sarvam.ai/voice-agents/api/deployments/webhooks/list.md)
- API Reference > Deployments > Webhooks [Retry webhook deliveries](https://docs.sarvam.ai/voice-agents/api/deployments/webhooks/retry.md)
- API Reference > Deployments > Cohorts [Upload cohort](https://docs.sarvam.ai/voice-agents/api/deployments/cohorts/upload.md)
- API Reference > Deployments > Cohorts [Stream cohort](https://docs.sarvam.ai/voice-agents/api/deployments/cohorts/stream.md)
- API Reference > Deployments > Cohorts [List cohorts](https://docs.sarvam.ai/voice-agents/api/deployments/cohorts/list.md)
- API Reference > Deployments > Cohorts [Get cohort](https://docs.sarvam.ai/voice-agents/api/deployments/cohorts/get.md)
- API Reference > Deployments > Cohorts [Download cohort file](https://docs.sarvam.ai/voice-agents/api/deployments/cohorts/download.md)
- API Reference > Campaigns [Create campaign](https://docs.sarvam.ai/voice-agents/api/campaigns/create.md)
- API Reference > Campaigns [List campaigns](https://docs.sarvam.ai/voice-agents/api/campaigns/list.md)
- API Reference > Campaigns [Get campaign](https://docs.sarvam.ai/voice-agents/api/campaigns/get.md)
- API Reference > Campaigns [Update campaign](https://docs.sarvam.ai/voice-agents/api/campaigns/update.md)
- API Reference > Campaigns [Update status](https://docs.sarvam.ai/voice-agents/api/campaigns/update-status.md)
- API Reference > Campaigns > Webhooks [List webhook deliveries](https://docs.sarvam.ai/voice-agents/api/campaigns/webhooks/list.md)
- API Reference > Campaigns > Webhooks [Retry webhook deliveries](https://docs.sarvam.ai/voice-agents/api/campaigns/webhooks/retry.md)
- API Reference > Campaigns > Cohorts [Upload cohort](https://docs.sarvam.ai/voice-agents/api/campaigns/cohorts/upload.md)
- API Reference > Campaigns > Cohorts [Stream cohort](https://docs.sarvam.ai/voice-agents/api/campaigns/cohorts/stream.md)
- API Reference > Campaigns > Cohorts [List cohorts](https://docs.sarvam.ai/voice-agents/api/campaigns/cohorts/list.md)
- API Reference > Campaigns > Cohorts [Get cohort](https://docs.sarvam.ai/voice-agents/api/campaigns/cohorts/get.md)
- API Reference > Campaigns > Cohorts [Download cohort file](https://docs.sarvam.ai/voice-agents/api/campaigns/cohorts/download.md)
- API Reference > Instant Outbound [Create outbound call](https://docs.sarvam.ai/voice-agents/api/instant-outbound/create.md)
- API Reference > Analytics [Get attempts](https://docs.sarvam.ai/voice-agents/api/analytics/attempts.md)
- API Reference > Analytics [Get interactions](https://docs.sarvam.ai/voice-agents/api/analytics/interactions.md)
- API Reference > Analytics [Get recordings](https://docs.sarvam.ai/voice-agents/api/analytics/recordings.md)
- API Reference > Analytics [Get transcripts](https://docs.sarvam.ai/voice-agents/api/analytics/transcripts.md)
- API Reference > Boards [List boards](https://docs.sarvam.ai/voice-agents/api/boards/list.md)
- API Reference > Boards [Create board](https://docs.sarvam.ai/voice-agents/api/boards/create.md)
- API Reference > Boards [Get board](https://docs.sarvam.ai/voice-agents/api/boards/get.md)
- API Reference > Boards [Update board](https://docs.sarvam.ai/voice-agents/api/boards/update.md)
- API Reference > Boards [Duplicate board](https://docs.sarvam.ai/voice-agents/api/boards/duplicate.md)
- API Reference > Boards > Tabs [Create tab](https://docs.sarvam.ai/voice-agents/api/boards/tabs/create.md)
- API Reference > Boards > Tabs [Update tab](https://docs.sarvam.ai/voice-agents/api/boards/tabs/update.md)
- API Reference > Boards > Tabs [Run tab](https://docs.sarvam.ai/voice-agents/api/boards/tabs/run.md)
- API Reference > Boards > Widgets [Create widget](https://docs.sarvam.ai/voice-agents/api/boards/widgets/create.md)
- API Reference > Boards > Widgets [Update widget](https://docs.sarvam.ai/voice-agents/api/boards/widgets/update.md)
- API Reference > Boards > Widgets [Duplicate widget](https://docs.sarvam.ai/voice-agents/api/boards/widgets/duplicate.md)
- API Reference > Boards > Widgets [Run widget](https://docs.sarvam.ai/voice-agents/api/boards/widgets/run.md)
- API Reference > Boards > Filters [List filters](https://docs.sarvam.ai/voice-agents/api/boards/filters/list.md)
- API Reference > Boards > Filters [Update filter](https://docs.sarvam.ai/voice-agents/api/boards/filters/update.md)
- API Reference > Boards > Notifications [Create notification rule](https://docs.sarvam.ai/voice-agents/api/boards/notifications/create.md)
- API Reference > Boards > Notifications [List notification rules](https://docs.sarvam.ai/voice-agents/api/boards/notifications/list.md)
- API Reference > Boards > Notifications [Get notification rule](https://docs.sarvam.ai/voice-agents/api/boards/notifications/get.md)
- API Reference > Boards > Notifications [Update notification rule](https://docs.sarvam.ai/voice-agents/api/boards/notifications/update.md)
- API Reference > Boards > Query [Get query schema](https://docs.sarvam.ai/voice-agents/api/boards/query/schema.md)
- API Reference > Boards > Query [Preview query](https://docs.sarvam.ai/voice-agents/api/boards/query/preview.md)
- API Reference > Tests [List test suites](https://docs.sarvam.ai/voice-agents/api/tests/list.md)
- API Reference > Tests [Create a test suite](https://docs.sarvam.ai/voice-agents/api/tests/create.md)
- API Reference > Tests [Get a test suite](https://docs.sarvam.ai/voice-agents/api/tests/get.md)
- API Reference > Tests [Update a test suite](https://docs.sarvam.ai/voice-agents/api/tests/update.md)
- API Reference > Tests > Test cases [Add a test case](https://docs.sarvam.ai/voice-agents/api/tests/test-cases/add.md)
- API Reference > Tests > Test cases [Get a test case](https://docs.sarvam.ai/voice-agents/api/tests/test-cases/get.md)
- API Reference > Tests > Test cases [Update a test case](https://docs.sarvam.ai/voice-agents/api/tests/test-cases/update.md)
- API Reference > Tests > Test cases [Duplicate a test case](https://docs.sarvam.ai/voice-agents/api/tests/test-cases/duplicate.md)
- API Reference > Tests > Variable mappings [Map suite variables onto an app](https://docs.sarvam.ai/voice-agents/api/tests/mappings/create.md)
- API Reference > Tests > Variable mappings [Get the variable mapping](https://docs.sarvam.ai/voice-agents/api/tests/mappings/get.md)
- API Reference > Tests > Runs [Run a test suite](https://docs.sarvam.ai/voice-agents/api/tests/runs/run-suite.md)
- API Reference > Tests > Runs [Run a single test case](https://docs.sarvam.ai/voice-agents/api/tests/runs/run-test-case.md)
- API Reference > Tests > Runs [List runs](https://docs.sarvam.ai/voice-agents/api/tests/runs/list.md)
- API Reference > Tests > Runs [Get a run](https://docs.sarvam.ai/voice-agents/api/tests/runs/get.md)
- API Reference > Tests > Runs [Get test case results](https://docs.sarvam.ai/voice-agents/api/tests/runs/results.md)
- API Reference > BYOK [Obtain access token](https://docs.sarvam.ai/voice-agents/api/byok/auth.md)
- API Reference > BYOK [Decrypt key](https://docs.sarvam.ai/voice-agents/api/byok/decrypt-key.md)
- API Reference > BYOK [Rotate key](https://docs.sarvam.ai/voice-agents/api/byok/rotate-key.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.sarvam.ai/voice-agents/api/openapi.json)
- [OpenAPI YAML](https://docs.sarvam.ai/voice-agents/api/openapi.yaml)