Create Conversation Flow Component

Create a new shared conversation flow component

POST /create-conversation-flow-component

JavaScript

JavaScript

import Retell from 'retell-sdk';

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

const conversationFlowComponentResponse = await client.conversationFlowComponent.create({
  name: 'Customer Information Collector',
  nodes: [
    {
      id: 'collect_info',
      instruction: {
        text: 'Ask the customer for their name and contact information.',
        type: 'prompt',
      },
      type: 'conversation',
    },
  ],
});

console.log(conversationFlowComponentResponse.conversation_flow_component_id);

201

{
  "name": "Customer Information Collector",
  "nodes": [
    {
      "id": "collect_info",
      "type": "conversation",
      "instruction": {
        "type": "prompt",
        "text": "Ask the customer for their name and contact information."
      }
    }
  ],
  "conversation_flow_component_id": "<string>",
  "user_modified_timestamp": 123,
  "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"
    }
  ],
  "mcps": [
    {
      "name": "<string>",
      "url": "<string>",
      "headers": {
        "Authorization": "Bearer 1234567890"
      },
      "query_params": {
        "index": "1",
        "key": "value"
      },
      "timeout_ms": 123
    }
  ],
  "start_node_id": "collect_info",
  "begin_tag_display_position": {
    "x": 100,
    "y": 200
  },
  "notes": [
    {
      "id": "note_abc123",
      "content": "Remember to handle edge cases here.",
      "display_position": {
        "x": 300,
        "y": 150
      },
      "size": {
        "width": 200,
        "height": 100
      }
    }
  ],
  "linked_conversation_flow_ids": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string · required

Name of the component

Example:

"Customer Information Collector"

nodes · object · object · object · any · any · any · any · any · any · any · any · any · object · any · any[] · required

Nodes that make up the component

Show child attributes

Example:

[
  {
    "id": "collect_info",
    "type": "conversation",
    "instruction": {
      "type": "prompt",
      "text": "Ask the customer for their name and contact information."
    }
  }
]

tools · object[] | null

Tools available within the component

Option 1

Option 2

Option 3

Show child attributes

Example:

[
  {
    "type": "custom",
    "name": "get_customer_info",
    "description": "Get customer information from database",
    "tool_id": "tool_001",
    "url": "https://api.example.com/customer",
    "method": "GET"
  }
]

mcps · object[] | null

A list of MCP server configurations to use for this component

Show child attributes

start_node_id · string | null

ID of the starting node

Example:

"collect_info"

begin_tag_display_position · object

Display position for the begin tag in the frontend

Show child attributes

notes · object[] | null

Visual annotations displayed on the flow canvas.

Show child attributes

Response

201

application/json

Successfully created conversation flow component

name · string · required

Name of the component

Example:

"Customer Information Collector"

nodes · object · any · any · any · any · any · any · any · any · any · any · any · object · any · any[] · required

Nodes that make up the component

Show child attributes

Example:

[
  {
    "id": "collect_info",
    "type": "conversation",
    "instruction": {
      "type": "prompt",
      "text": "Ask the customer for their name and contact information."
    }
  }
]

conversation_flow_component_id · string · required

Unique identifier for the component

user_modified_timestamp · integer<int64> · required

Timestamp of last user modification

tools · object[] | null

Tools available within the component

Option 1

Option 2

Option 3

Show child attributes

Example:

[
  {
    "type": "custom",
    "name": "get_customer_info",
    "description": "Get customer information from database",
    "tool_id": "tool_001",
    "url": "https://api.example.com/customer",
    "method": "GET"
  }
]

mcps · object[] | null

A list of MCP server configurations to use for this component

Show child attributes

start_node_id · string | null

ID of the starting node

Example:

"collect_info"

begin_tag_display_position · object

Display position for the begin tag in the frontend

Show child attributes

notes · object[] | null

Visual annotations displayed on the flow canvas.

Show child attributes

linked_conversation_flow_ids · string[]

IDs of conversation flows linked to this shared component