curl --request POST \
--url https://tavusapi.com/v2/objectives \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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_objectives": [
"get_patient_name"
],
"callback_url": "https://your-server.com/webhook"
}
]'
{
"objectives_id": "o12345",
"objective_name": "New Objectives",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
This endpoint creates a new objective for a persona. Objectives provide goal-oriented instructions that help guide conversations toward specific achievements and desired outcomes.
curl --request POST \
--url https://tavusapi.com/v2/objectives \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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_objectives": [
"get_patient_name"
],
"callback_url": "https://your-server.com/webhook"
}
]'
{
"objectives_id": "o12345",
"objective_name": "New Objectives",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
The body is of type object[]
.
Objective created successfully
The response is of type object
.