GET /v2/list-retell-llms

Changed on

List Retell LLM Response Engines with pagination

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of items to return.

sort_order'ascending' | 'descending'

Sort order for results.

pagination_keystring

Pagination key for fetching the next page.

Response

Successfully retrieved Retell LLM Response Engines.

pagination_keystring

Pagination key for the next page.

has_moreboolean required

Whether more results are available.

Example response

{
  "items": [
    {
      "llm_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
      "model_high_priority": true,
      "model_ultrafast": true,
      "kb_config": {
        "top_k": 3,
        "filter_score": 0.6
      },
      "begin_after_user_silence_ms": 2000,
      "begin_message": "Hey I am a virtual assistant calling from Retell Hospital.",
      "general_prompt": "You are ...",
      "voice_prompt": "You are a friendly voice assistant for ...",
      "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",
                "ignore_e164_validation": false
              },
              "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": "custom",
              "name": "book_appointment",
              "description": "Book an annual check up.",
              "url": "https://api.example.com/book-appointment",
              "method": "POST"
            }
          ]
        }
      ],
      "starting_state": "information_collection",
      "default_dynamic_variables": {
        "customer_name": "John Doe"
      },
      "mcps": [
        {
          "headers": {
            "Authorization": "Bearer 1234567890"
          },
          "query_params": {
            "index": "1",
            "key": "value"
          }
        }
      ],
      "last_modification_timestamp": 1703413636133
    }
  ]
}

Changes

    • warning

      removed the optional property //////////////// from the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added to the /////////// response property anyOf list for the response status