Skip to main content
GET
/
v2
/
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_objective": "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.tavus.io/llms.txt

Use this file to discover all available pages before exploring further.

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[]

Objectives for the current page; use total_count for the full count.

total_count
integer

The total number of objectives

Example:

25