Skip to navigation
Voice Agents

Introduction

Manage deployments, campaigns, outbound calls, and analytics for your voice agents over REST.
View as Markdown

The Voice Agents API lets you manage your voice agents programmatically — create deployments, run outbound campaigns, place instant calls, pull call analytics, build custom analytics boards, and run test suites against your agents — without using the dashboard.

Authentication

All requests are authenticated with an API key sent in the X-API-Key header. Create and manage keys from Settings → API Key in the dashboard.

X-API-Key: <your-api-key>

Base URLs

Endpoints are grouped by service, and each service has its own base URL:

ServiceBase URL
Deploymentshttps://apps.sarvam.ai/api/app-authoring
Campaigns & Cohortshttps://apps.sarvam.ai/api/scheduling
Instant Outboundhttps://apps.sarvam.ai/api/outbounds
Analytics & Boardshttps://apps.sarvam.ai/api/analytics
Testshttps://apps.sarvam.ai/api/evals
BYOKHosted by you — see the BYOK overview

Organization and workspace scope

Most endpoints are scoped to an organization and workspace, so their paths include org_id and workspace_id. Copy these identifiers from your dashboard URL, or from Settings.

The path shape depends on the service. Deployments, Campaigns & Cohorts, and Instant Outbound name each segment:

/v1/orgs/{org_id}/workspaces/{workspace_id}/deployments

Analytics, Boards, and Tests put the identifiers directly after the version. Analytics endpoints also take the agent’s app_id:

/v1/{org_id}/{workspace_id}/boards
/v1/{org_id}/{workspace_id}/{app_id}/interactions