Create Objectives
curl --request POST \
--url https://tavusapi.com/v2/objectives \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"data": [
{
"objective_name": "ask_if_new_patient",
"objective_prompt": "Ask the patient if they are new or have been here before",
"confirmation_mode": "auto",
"output_variables": [
"patient_status"
],
"modality": "verbal",
"next_conditional_objectives": {
"new_patient_intake_process": "If the patient has never been to the practice before",
"existing_patient_intake_process": "If the patient has been to the practice before"
},
"next_required_objective": "get_patient_name",
"callback_url": "https://your-server.com/webhook"
}
]
}
'import requests
url = "https://tavusapi.com/v2/objectives"
payload = { "data": [
{
"objective_name": "ask_if_new_patient",
"objective_prompt": "Ask the patient if they are new or have been here before",
"confirmation_mode": "auto",
"output_variables": ["patient_status"],
"modality": "verbal",
"next_conditional_objectives": {
"new_patient_intake_process": "If the patient has never been to the practice before",
"existing_patient_intake_process": "If the patient has been to the practice before"
},
"next_required_objective": "get_patient_name",
"callback_url": "https://your-server.com/webhook"
}
] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
objective_name: 'ask_if_new_patient',
objective_prompt: 'Ask the patient if they are new or have been here before',
confirmation_mode: 'auto',
output_variables: ['patient_status'],
modality: 'verbal',
next_conditional_objectives: {
new_patient_intake_process: 'If the patient has never been to the practice before',
existing_patient_intake_process: 'If the patient has been to the practice before'
},
next_required_objective: 'get_patient_name',
callback_url: 'https://your-server.com/webhook'
}
]
})
};
fetch('https://tavusapi.com/v2/objectives', 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/objectives",
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([
'data' => [
[
'objective_name' => 'ask_if_new_patient',
'objective_prompt' => 'Ask the patient if they are new or have been here before',
'confirmation_mode' => 'auto',
'output_variables' => [
'patient_status'
],
'modality' => 'verbal',
'next_conditional_objectives' => [
'new_patient_intake_process' => 'If the patient has never been to the practice before',
'existing_patient_intake_process' => 'If the patient has been to the practice before'
],
'next_required_objective' => 'get_patient_name',
'callback_url' => 'https://your-server.com/webhook'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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/objectives"
payload := strings.NewReader("{\n \"data\": [\n {\n \"objective_name\": \"ask_if_new_patient\",\n \"objective_prompt\": \"Ask the patient if they are new or have been here before\",\n \"confirmation_mode\": \"auto\",\n \"output_variables\": [\n \"patient_status\"\n ],\n \"modality\": \"verbal\",\n \"next_conditional_objectives\": {\n \"new_patient_intake_process\": \"If the patient has never been to the practice before\",\n \"existing_patient_intake_process\": \"If the patient has been to the practice before\"\n },\n \"next_required_objective\": \"get_patient_name\",\n \"callback_url\": \"https://your-server.com/webhook\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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/objectives")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"objective_name\": \"ask_if_new_patient\",\n \"objective_prompt\": \"Ask the patient if they are new or have been here before\",\n \"confirmation_mode\": \"auto\",\n \"output_variables\": [\n \"patient_status\"\n ],\n \"modality\": \"verbal\",\n \"next_conditional_objectives\": {\n \"new_patient_intake_process\": \"If the patient has never been to the practice before\",\n \"existing_patient_intake_process\": \"If the patient has been to the practice before\"\n },\n \"next_required_objective\": \"get_patient_name\",\n \"callback_url\": \"https://your-server.com/webhook\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tavusapi.com/v2/objectives")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"objective_name\": \"ask_if_new_patient\",\n \"objective_prompt\": \"Ask the patient if they are new or have been here before\",\n \"confirmation_mode\": \"auto\",\n \"output_variables\": [\n \"patient_status\"\n ],\n \"modality\": \"verbal\",\n \"next_conditional_objectives\": {\n \"new_patient_intake_process\": \"If the patient has never been to the practice before\",\n \"existing_patient_intake_process\": \"If the patient has been to the practice before\"\n },\n \"next_required_objective\": \"get_patient_name\",\n \"callback_url\": \"https://your-server.com/webhook\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"objectives_id": "o12345",
"objective_name": "New Objectives",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}{
"message": "objective_name is required"
}{
"message": "Invalid access token"
}Objectives
Create Objectives
This endpoint creates objectives for a PAL.
POST
/
v2
/
objectives
Create Objectives
curl --request POST \
--url https://tavusapi.com/v2/objectives \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"data": [
{
"objective_name": "ask_if_new_patient",
"objective_prompt": "Ask the patient if they are new or have been here before",
"confirmation_mode": "auto",
"output_variables": [
"patient_status"
],
"modality": "verbal",
"next_conditional_objectives": {
"new_patient_intake_process": "If the patient has never been to the practice before",
"existing_patient_intake_process": "If the patient has been to the practice before"
},
"next_required_objective": "get_patient_name",
"callback_url": "https://your-server.com/webhook"
}
]
}
'import requests
url = "https://tavusapi.com/v2/objectives"
payload = { "data": [
{
"objective_name": "ask_if_new_patient",
"objective_prompt": "Ask the patient if they are new or have been here before",
"confirmation_mode": "auto",
"output_variables": ["patient_status"],
"modality": "verbal",
"next_conditional_objectives": {
"new_patient_intake_process": "If the patient has never been to the practice before",
"existing_patient_intake_process": "If the patient has been to the practice before"
},
"next_required_objective": "get_patient_name",
"callback_url": "https://your-server.com/webhook"
}
] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
objective_name: 'ask_if_new_patient',
objective_prompt: 'Ask the patient if they are new or have been here before',
confirmation_mode: 'auto',
output_variables: ['patient_status'],
modality: 'verbal',
next_conditional_objectives: {
new_patient_intake_process: 'If the patient has never been to the practice before',
existing_patient_intake_process: 'If the patient has been to the practice before'
},
next_required_objective: 'get_patient_name',
callback_url: 'https://your-server.com/webhook'
}
]
})
};
fetch('https://tavusapi.com/v2/objectives', 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/objectives",
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([
'data' => [
[
'objective_name' => 'ask_if_new_patient',
'objective_prompt' => 'Ask the patient if they are new or have been here before',
'confirmation_mode' => 'auto',
'output_variables' => [
'patient_status'
],
'modality' => 'verbal',
'next_conditional_objectives' => [
'new_patient_intake_process' => 'If the patient has never been to the practice before',
'existing_patient_intake_process' => 'If the patient has been to the practice before'
],
'next_required_objective' => 'get_patient_name',
'callback_url' => 'https://your-server.com/webhook'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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/objectives"
payload := strings.NewReader("{\n \"data\": [\n {\n \"objective_name\": \"ask_if_new_patient\",\n \"objective_prompt\": \"Ask the patient if they are new or have been here before\",\n \"confirmation_mode\": \"auto\",\n \"output_variables\": [\n \"patient_status\"\n ],\n \"modality\": \"verbal\",\n \"next_conditional_objectives\": {\n \"new_patient_intake_process\": \"If the patient has never been to the practice before\",\n \"existing_patient_intake_process\": \"If the patient has been to the practice before\"\n },\n \"next_required_objective\": \"get_patient_name\",\n \"callback_url\": \"https://your-server.com/webhook\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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/objectives")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"objective_name\": \"ask_if_new_patient\",\n \"objective_prompt\": \"Ask the patient if they are new or have been here before\",\n \"confirmation_mode\": \"auto\",\n \"output_variables\": [\n \"patient_status\"\n ],\n \"modality\": \"verbal\",\n \"next_conditional_objectives\": {\n \"new_patient_intake_process\": \"If the patient has never been to the practice before\",\n \"existing_patient_intake_process\": \"If the patient has been to the practice before\"\n },\n \"next_required_objective\": \"get_patient_name\",\n \"callback_url\": \"https://your-server.com/webhook\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tavusapi.com/v2/objectives")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"objective_name\": \"ask_if_new_patient\",\n \"objective_prompt\": \"Ask the patient if they are new or have been here before\",\n \"confirmation_mode\": \"auto\",\n \"output_variables\": [\n \"patient_status\"\n ],\n \"modality\": \"verbal\",\n \"next_conditional_objectives\": {\n \"new_patient_intake_process\": \"If the patient has never been to the practice before\",\n \"existing_patient_intake_process\": \"If the patient has been to the practice before\"\n },\n \"next_required_objective\": \"get_patient_name\",\n \"callback_url\": \"https://your-server.com/webhook\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"objectives_id": "o12345",
"objective_name": "New Objectives",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}{
"message": "objective_name is required"
}{
"message": "Invalid access token"
}For AI agents, use
https://docs.tavus.io/openapi.yaml for the full HTTP API contract.Authorizations
Body
application/json
Array of objectives to create. Objectives provide goal-oriented instructions that help guide conversations toward specific achievements and desired outcomes.
Show child attributes
Show child attributes
Response
Objective created successfully
Unique identifier for the created objective
Example:
"o12345"
Name of the objective
Example:
"New Objectives"
Current status of the objective
Example:
"active"
ISO 8601 timestamp of when the objective was created
Example:
"2024-01-15T10:30:00Z"
⌘I

