curl --request GET \
--url https://tavusapi.com/v2/objectives/{objectives_id} \
--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",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}
This endpoint returns a single objective by its unique identifier.
curl --request GET \
--url https://tavusapi.com/v2/objectives/{objectives_id} \
--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",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}
The unique identifier of the objective.
"o12345"
Successfully retrieved objective
The response is of type object
.