> 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 full documentation content in one file, see https://docs.sarvam.ai/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server. # Create deployment POST https://apps.sarvam.ai/api/app-authoring/v1/orgs/{org_id}/workspaces/{workspace_id}/deployments Content-Type: application/json Create a new deployment that connects an agent to a phone number for inbound calls. The deployment is created in `active` status and immediately begins accepting calls. Optionally configure an `inbound_config` schedule to restrict calls to specific hours and days. Reference: https://docs.sarvam.ai/conversations/api/deployments/create ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: agents version: 1.0.0 paths: /v1/orgs/{org_id}/workspaces/{workspace_id}/deployments: post: operationId: create-deployment summary: Create Deployment description: >- Create a new deployment that connects an agent to a phone number for inbound calls. The deployment is created in `active` status and immediately begins accepting calls. Optionally configure an `inbound_config` schedule to restrict calls to specific hours and days. tags: - v1-deployments parameters: - name: org_id in: path required: true schema: type: string - name: workspace_id in: path required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeploymentDetails' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeployment' servers: - url: https://apps.sarvam.ai/api/app-authoring description: Production components: schemas: ConnectionConfig: type: object properties: connection_id: type: string agent_phone_number: type: string required: - connection_id - agent_phone_number title: ConnectionConfig DaysOfWeek: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday description: Days of the week for scheduling. title: DaysOfWeek InboundConfig: type: object properties: start_time: type: string format: time description: Start time in HH:MM 24-hour format end_time: type: string format: time description: End time in HH:MM 24-hour format allowed_days: type: array items: $ref: '#/components/schemas/DaysOfWeek' description: Days of the week when inbound calls are accepted timezone: type: string format: zoneinfo default: Asia/Kolkata description: IANA timezone, e.g. 'Asia/Kolkata', 'UTC', 'America/New_York' required: - start_time - end_time - allowed_days description: >- Inbound call configuration including schedule, connection, and call handling settings. title: InboundConfig CreateDeployment: type: object properties: name: type: string description: >- Deployment name. Alphanumeric, hyphens, underscores and spaces allowed. Max 50 characters. description: type: - string - 'null' description: Optional deployment description. Max 150 characters. app_id: type: string description: ID of the agent app_version: type: integer description: Version of the agent to deploy connection_configs: type: array items: $ref: '#/components/schemas/ConnectionConfig' description: Telephony connection configurations with phone numbers inbound_config: oneOf: - $ref: '#/components/schemas/InboundConfig' - type: 'null' description: Optional inbound call schedule configuration required: - name - app_id - app_version - connection_configs description: Request body for creating a new deployment. title: CreateDeployment DeploymentStatus: type: string enum: - active - paused description: Deployment lifecycle status. title: DeploymentStatus ChannelDirection: type: string enum: - inbound - outbound - inbound_outbound title: ChannelDirection DeploymentDetails: type: object properties: name: type: - string - 'null' description: Name of the deployment deployment_id: type: string description: Unique identifier for the deployment status: oneOf: - $ref: '#/components/schemas/DeploymentStatus' - type: 'null' description: Current status of the deployment description: type: - string - 'null' description: Optional description app_id: type: string description: ID of the agent app_version: type: integer description: Version of the agent connection_configs: type: array items: $ref: '#/components/schemas/ConnectionConfig' description: Telephony connection configurations channel_direction: $ref: '#/components/schemas/ChannelDirection' description: Direction of calls (inbound, outbound, or both) inbound_config: oneOf: - $ref: '#/components/schemas/InboundConfig' - type: 'null' description: Inbound call schedule configuration created_by: type: string description: User who created this deployment created_at: type: string format: date-time description: Timestamp when created (ISO 8601) updated_by: type: - string - 'null' description: User who last updated this deployment updated_at: type: string format: date-time description: Timestamp when last updated (ISO 8601) required: - deployment_id - app_id - app_version - connection_configs - channel_direction - created_by - created_at - updated_at description: >- Full deployment details including agent configuration, inbound settings, and status. title: DeploymentDetails ErrorBody: type: object properties: code: type: string description: A service-specific error code. message: type: string description: A human-readable description of the error. required: - code - message description: Details of the error that occurred. title: ErrorBody ErrorResponse: type: object properties: error: $ref: '#/components/schemas/ErrorBody' required: - error description: A standard wrapper for all error responses. title: ErrorResponse ``` ## Examples **Request** ```json { "name": "Customer Support Line", "app_id": "my-support-agent", "app_version": 3, "connection_configs": [ { "connection_id": "conn-exotel-001", "phone_numbers": [ "+918047168000" ] } ], "description": "Main support deployment for EN and HI", "inbound_config": { "start_time": "09:00", "end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" } } ``` **Response** ```json { "deployment_id": "dep-a1b2c3d4", "app_id": "my-support-agent", "app_version": 3, "connection_configs": [ { "connection_id": "conn-exotel-001", "phone_numbers": [ "+918047168000" ] } ], "channel_direction": "inbound", "created_by": "user@company.com", "created_at": "2026-03-01T10:00:00Z", "updated_at": "2026-03-15T14:30:00Z", "name": "Customer Support Line", "status": "active", "description": "Main support deployment for EN and HI", "inbound_config": { "start_time": "09:00", "end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" }, "updated_by": "user@company.com" } ``` **SDK Code** ```python import requests url = "https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments" payload = { "name": "Customer Support Line", "app_id": "my-support-agent", "app_version": 3, "connection_configs": [ { "connection_id": "conn-exotel-001", "phone_numbers": ["+918047168000"] } ], "description": "Main support deployment for EN and HI", "inbound_config": { "start_time": "09:00", "end_time": "18:00", "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"], "timezone": "Asia/Kolkata" } } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"name":"Customer Support Line","app_id":"my-support-agent","app_version":3,"connection_configs":[{"connection_id":"conn-exotel-001","phone_numbers":["+918047168000"]}],"description":"Main support deployment for EN and HI","inbound_config":{"start_time":"09:00","end_time":"18:00","allowed_days":["Monday","Tuesday","Wednesday","Thursday","Friday"],"timezone":"Asia/Kolkata"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments" payload := strings.NewReader("{\n \"name\": \"Customer Support Line\",\n \"app_id\": \"my-support-agent\",\n \"app_version\": 3,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-exotel-001\",\n \"phone_numbers\": [\n \"+918047168000\"\n ]\n }\n ],\n \"description\": \"Main support deployment for EN and HI\",\n \"inbound_config\": {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Customer Support Line\",\n \"app_id\": \"my-support-agent\",\n \"app_version\": 3,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-exotel-001\",\n \"phone_numbers\": [\n \"+918047168000\"\n ]\n }\n ],\n \"description\": \"Main support deployment for EN and HI\",\n \"inbound_config\": {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments") .header("Content-Type", "application/json") .body("{\n \"name\": \"Customer Support Line\",\n \"app_id\": \"my-support-agent\",\n \"app_version\": 3,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-exotel-001\",\n \"phone_numbers\": [\n \"+918047168000\"\n ]\n }\n ],\n \"description\": \"Main support deployment for EN and HI\",\n \"inbound_config\": {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n }\n}") .asString(); ``` ```php request('POST', 'https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments', [ 'body' => '{ "name": "Customer Support Line", "app_id": "my-support-agent", "app_version": 3, "connection_configs": [ { "connection_id": "conn-exotel-001", "phone_numbers": [ "+918047168000" ] } ], "description": "Main support deployment for EN and HI", "inbound_config": { "start_time": "09:00", "end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" } }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Customer Support Line\",\n \"app_id\": \"my-support-agent\",\n \"app_version\": 3,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-exotel-001\",\n \"phone_numbers\": [\n \"+918047168000\"\n ]\n }\n ],\n \"description\": \"Main support deployment for EN and HI\",\n \"inbound_config\": {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "name": "Customer Support Line", "app_id": "my-support-agent", "app_version": 3, "connection_configs": [ [ "connection_id": "conn-exotel-001", "phone_numbers": ["+918047168000"] ] ], "description": "Main support deployment for EN and HI", "inbound_config": [ "start_time": "09:00", "end_time": "18:00", "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"], "timezone": "Asia/Kolkata" ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```