GET
/
get-conversation-flow
/
{conversation_flow_id}
JavaScript
import Retell from 'retell-sdk';

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

const conversationFlowResponse = await client.conversationFlow.retrieve('conversation_flow_id');

console.log(conversationFlowResponse.conversation_flow_id);
{
  "global_prompt": "You are a helpful customer service agent.",
  "tools": [
    {
      "type": "custom",
      "name": "get_customer_info",
      "description": "Get customer information from database",
      "tool_id": "tool_001",
      "url": "https://api.example.com/customer",
      "method": "GET"
    }
  ],
  "start_node_id": "start",
  "model_temperature": 0.7,
  "tool_call_strict_mode": true,
  "default_dynamic_variables": {
    "company_name": "Retell Inc",
    "support_hours": "9 AM - 5 PM"
  },
  "knowledge_base_ids": [
    "kb_001",
    "kb_002"
  ],
  "begin_tag_display_position": {
    "x": 100,
    "y": 200
  },
  "mcps": [
    {
      "name": "<string>",
      "url": "<string>",
      "headers": {
        "Authorization": "Bearer 1234567890"
      },
      "query_params": {
        "index": "1",
        "key": "value"
      },
      "timeout_ms": 123
    }
  ],
  "start_speaker": "agent",
  "model_choice": {
    "type": "cascading",
    "model": "gpt-4o",
    "high_priority": true
  },
  "nodes": [
    {
      "id": "start",
      "type": "conversation",
      "instruction": {
        "type": "prompt",
        "text": "Greet the customer and ask how you can help them."
      },
      "edges": [
        {
          "id": "edge_1",
          "transition_condition": {
            "type": "prompt",
            "prompt": "Customer wants to book appointment"
          },
          "destination_node_id": "book_appointment"
        }
      ]
    }
  ],
  "conversation_flow_id": "<string>",
  "version": 123
}

Authorizations

Authorization
string
header
required

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

Path Parameters

conversation_flow_id
string
required

Unique id of the conversation flow to be retrieved.

Query Parameters

version
string

Response

200
application/json

Successfully retrieved the conversation flow

The response is of type object.