Start Deployment Conversation
curl --request POST \
--url https://tavusapi.com/v2/deployments/{deployment_id}/start \
--header 'Content-Type: application/json' \
--data '
{
"password": "<string>",
"conversational_context": "<string>",
"custom_greeting": "<string>",
"pal_id": "<string>",
"memory_stores": [
"<string>"
],
"captcha_token": "<string>"
}
'import requests
url = "https://tavusapi.com/v2/deployments/{deployment_id}/start"
payload = {
"password": "<string>",
"conversational_context": "<string>",
"custom_greeting": "<string>",
"pal_id": "<string>",
"memory_stores": ["<string>"],
"captcha_token": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
password: '<string>',
conversational_context: '<string>',
custom_greeting: '<string>',
pal_id: '<string>',
memory_stores: ['<string>'],
captcha_token: '<string>'
})
};
fetch('https://tavusapi.com/v2/deployments/{deployment_id}/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tavusapi.com/v2/deployments/{deployment_id}/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'password' => '<string>',
'conversational_context' => '<string>',
'custom_greeting' => '<string>',
'pal_id' => '<string>',
'memory_stores' => [
'<string>'
],
'captcha_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://tavusapi.com/v2/deployments/{deployment_id}/start"
payload := strings.NewReader("{\n \"password\": \"<string>\",\n \"conversational_context\": \"<string>\",\n \"custom_greeting\": \"<string>\",\n \"pal_id\": \"<string>\",\n \"memory_stores\": [\n \"<string>\"\n ],\n \"captcha_token\": \"<string>\"\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(string(body))
}HttpResponse<String> response = Unirest.post("https://tavusapi.com/v2/deployments/{deployment_id}/start")
.header("Content-Type", "application/json")
.body("{\n \"password\": \"<string>\",\n \"conversational_context\": \"<string>\",\n \"custom_greeting\": \"<string>\",\n \"pal_id\": \"<string>\",\n \"memory_stores\": [\n \"<string>\"\n ],\n \"captcha_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tavusapi.com/v2/deployments/{deployment_id}/start")
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 \"password\": \"<string>\",\n \"conversational_context\": \"<string>\",\n \"custom_greeting\": \"<string>\",\n \"pal_id\": \"<string>\",\n \"memory_stores\": [\n \"<string>\"\n ],\n \"captcha_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"conversation_id": "<string>",
"conversation_name": "<string>",
"conversation_url": "<string>",
"status": "<string>",
"callback_url": "<string>",
"created_at": "<string>",
"meeting_token": "<string>"
}Deployments
Start Deployment Conversation
Creates a conversation for a deployment. Returns the same fields as Create Conversation.
No API key required in the browser. Password, Turnstile, and call-limit checks apply for public callers.
POST
/
v2
/
deployments
/
{deployment_id}
/
start
Start Deployment Conversation
curl --request POST \
--url https://tavusapi.com/v2/deployments/{deployment_id}/start \
--header 'Content-Type: application/json' \
--data '
{
"password": "<string>",
"conversational_context": "<string>",
"custom_greeting": "<string>",
"pal_id": "<string>",
"memory_stores": [
"<string>"
],
"captcha_token": "<string>"
}
'import requests
url = "https://tavusapi.com/v2/deployments/{deployment_id}/start"
payload = {
"password": "<string>",
"conversational_context": "<string>",
"custom_greeting": "<string>",
"pal_id": "<string>",
"memory_stores": ["<string>"],
"captcha_token": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
password: '<string>',
conversational_context: '<string>',
custom_greeting: '<string>',
pal_id: '<string>',
memory_stores: ['<string>'],
captcha_token: '<string>'
})
};
fetch('https://tavusapi.com/v2/deployments/{deployment_id}/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tavusapi.com/v2/deployments/{deployment_id}/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'password' => '<string>',
'conversational_context' => '<string>',
'custom_greeting' => '<string>',
'pal_id' => '<string>',
'memory_stores' => [
'<string>'
],
'captcha_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://tavusapi.com/v2/deployments/{deployment_id}/start"
payload := strings.NewReader("{\n \"password\": \"<string>\",\n \"conversational_context\": \"<string>\",\n \"custom_greeting\": \"<string>\",\n \"pal_id\": \"<string>\",\n \"memory_stores\": [\n \"<string>\"\n ],\n \"captcha_token\": \"<string>\"\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(string(body))
}HttpResponse<String> response = Unirest.post("https://tavusapi.com/v2/deployments/{deployment_id}/start")
.header("Content-Type", "application/json")
.body("{\n \"password\": \"<string>\",\n \"conversational_context\": \"<string>\",\n \"custom_greeting\": \"<string>\",\n \"pal_id\": \"<string>\",\n \"memory_stores\": [\n \"<string>\"\n ],\n \"captcha_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tavusapi.com/v2/deployments/{deployment_id}/start")
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 \"password\": \"<string>\",\n \"conversational_context\": \"<string>\",\n \"custom_greeting\": \"<string>\",\n \"pal_id\": \"<string>\",\n \"memory_stores\": [\n \"<string>\"\n ],\n \"captcha_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"conversation_id": "<string>",
"conversation_name": "<string>",
"conversation_url": "<string>",
"status": "<string>",
"callback_url": "<string>",
"created_at": "<string>",
"meeting_token": "<string>"
}For AI agents, use
https://docs.tavus.io/openapi.yaml for the full HTTP API contract.Path Parameters
Body
application/json
⌘I

