Get Objective

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"
  }
}

GET

objectives

{objectives_id}

Get Objective

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"
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

objectives_id

string

required

The unique identifier of the objective.

Example:

"o12345"

Response

Successfully retrieved objective

data

object

Show child attributes

data.objective_name

string

Name of the objective

Example:

"ask_if_new_patient"

data.objective_prompt

string

The detailed prompt that defines what the objective should accomplish

Example:

"Ask the patient if they are new or have been here before"

data.confirmation_mode

string

How the objective completion should be confirmed

Example:

"auto"

data.output_variables

string[]

List of variables that should be extracted or collected during the objective

Example:

["patient_status"]

data.modality

string

The communication modality for the objective

Example:

"verbal"

data.next_conditional_objectives

object

Mapping of objective names to conditions that must be satisfied for that objective to be activated

Show child attributes

data.next_conditional_objectives.{key}

string

Example:

{
  "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"
}

data.next_required_objectives

string[]

List of objective names that will be activated once the current objective is completed

Example:

["get_patient_name"]

data.callback_url

string

URL that will receive notifications when the objective is completed

Example:

"https://your-server.com/webhook"

data.created_at

string

ISO 8601 timestamp of when the objective was created

Example:

"2024-01-15T10:30:00Z"

data.updated_at

string

ISO 8601 timestamp of when the objective was last updated

Example:

"2024-01-15T10:30:00Z"

Create Objectives Get Objectives

⌘I

Introduction

Conversation

Persona

Replica

Objectives

Guardrails

Knowledge Base

Video Generation

Get Objective

Authorizations

Path Parameters

Response