Get Objectives

curl --request GET \
  --url https://tavusapi.com/v2/objectives \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "objectives_id": "o12345",
      "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"
    }
  ],
  "total_count": 25
}

GET

objectives

Get Objectives

curl --request GET \
  --url https://tavusapi.com/v2/objectives \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "objectives_id": "o12345",
      "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"
    }
  ],
  "total_count": 25
}

Authorizations

x-api-key

string

header

required

Query Parameters

limit

integer

The number of objectives to return per page. Default is 10.

page

integer

The page number to return. Default is 1.

Response

Successfully retrieved objectives

data

object[]

Show child attributes

data.objectives_id

string

Unique identifier for the objective

Example:

"o12345"

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"

total_count

integer

The total number of objectives

Example:

25

Get Objective Patch Objective

⌘I

Introduction

Conversation

Persona

Replica

Objectives

Guardrails

Knowledge Base

Video Generation

Get Objectives

Authorizations

Query Parameters

Response