GET
/
list-retell-llms
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
});

const llmResponses = await client.llm.list();

console.log(llmResponses);
[
  {
    "llm_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
    "version": 0,
    "is_published": false,
    "model": "gpt-4o",
    "s2s_model": "gpt-4o-realtime",
    "model_temperature": 0,
    "model_high_priority": true,
    "tool_call_strict_mode": true,
    "general_prompt": "You are ...",
    "general_tools": [
      {
        "type": "end_call",
        "name": "end_call",
        "description": "End the call with user."
      }
    ],
    "states": [
      {
        "name": "information_collection",
        "state_prompt": "You will follow the steps below to collect information...",
        "edges": [
          {
            "destination_state_name": "appointment_booking",
            "description": "Transition to book an appointment."
          }
        ],
        "tools": [
          {
            "type": "transfer_call",
            "name": "transfer_to_support",
            "description": "Transfer to the support team.",
            "transfer_destination": {
              "type": "predefined",
              "number": "16175551212"
            },
            "transfer_option": {
              "type": "cold_transfer",
              "show_transferee_as_caller": false
            }
          }
        ]
      },
      {
        "name": "appointment_booking",
        "state_prompt": "You will follow the steps below to book an appointment...",
        "tools": [
          {
            "type": "book_appointment_cal",
            "name": "book_appointment",
            "description": "Book an annual check up.",
            "cal_api_key": "cal_live_xxxxxxxxxxxx",
            "event_type_id": 60444,
            "timezone": "America/Los_Angeles"
          }
        ]
      }
    ],
    "starting_state": "information_collection",
    "begin_message": "Hey I am a virtual assistant calling from Retell Hospital.",
    "default_dynamic_variables": {
      "customer_name": "John Doe"
    },
    "knowledge_base_ids": [
      "<string>"
    ],
    "last_modification_timestamp": 1703413636133
  }
]

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Query Parameters

​
limit
integer

A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 1000.

Example:

50

​
pagination_key
string

The pagination key to continue fetching the next page of LLMs. Pagination key is represented by a llm id, pagination key and version pair is exclusive (not included in the fetched page). If not set, will start from the beginning.

Example:

"llm_1ffdb9717444d0e77346838911"

​
pagination_key_version
integer

Specifies the version of the llm associated with the pagination_key. When paginating, both the pagination_key and its version must be provided to ensure consistent ordering and to fetch the next page correctly.

Example:

0

Response

200
application/json

Successfully retrieved all Retell LLM Response Engines.

The response is of type object[].