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

POST

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

Authorizations

x-api-key

string

header

required

Body

application/json

data

object[]

required

Array of objectives to create

Show child attributes

data.objective_name

string

required

A descriptive name for the objective. This must be a string value without spaces.

Example:

"ask_if_new_patient"

data.objective_prompt

string

required

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

enum<string>

default:auto

How the objective completion should be confirmed. If set to manual, the user will be prompted to confirm the objective completion. If set to auto, the LLM will determine whether the objective was completed or not.

Available options:

auto,

manual

Example:

"auto"

data.output_variables

string[]

Optional list of variables that should be extracted or collected during the objective.

Example:

["patient_status"]

data.modality

enum<string>

default:verbal

The communication modality for the objective. If set to verbal, the objective will be completed by the user's responses. If set to visual, the objective can only be completed by visual / perception cues observed by Raven.

Available options:

verbal,

visual

Example:

"verbal"

data.next_conditional_objectives

object

A 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

Optional URL that will receive notifications when the objective is completed.

Example:

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

Response

Objective created successfully

objectives_id

string

Unique identifier for the created objective

Example:

"o12345"

objective_name

string

Name of the objective

Example:

"New Objectives"

status

string

Current status of the objective

Example:

"active"

created_at

string

ISO 8601 timestamp of when the objective was created

Example:

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

Rename Replica Get Objective

⌘I

Introduction

Conversation

Persona

Replica

Objectives

Guardrails

Knowledge Base

Video Generation

Create Objectives

Authorizations

Body

Response