Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Retell AI Create Conversation Flow Component API

The Create Conversation Flow Component API from Retell AI — 1 operation(s) for create conversation flow component.

Retell AI Create Conversation Flow Component API is one of 78 APIs that Retell AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Create Conversation Flow Component. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and pricing.

This API exposes 1 operation across 1 path, and defines 84 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://api.retellai.com.

1 operations 1 paths 84 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://api.retellai.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Retell AI Create Conversation Flow Component API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (string) (api_key). By default, every request must be authenticated.

  • api_key — Authentication header containing API key (find it in dashboard). The format is "Bearer YOURAPIKEY"

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Create Conversation Flow Component 1
POST
/create-conversation-flow-component
Create a new shared conversation flow component
createConversationFlowComponent body → 201400401404429500

Schemas 84

The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are CustomTool (16 properties), AgentSwapTool (12 properties), CodeTool (11 properties), MCPTool (11 properties). Each schema is shown below with its type and property counts.

FunctionNode
TransferOptionColdTransfer
object
4 properties 1 required
WarmTransferStaticMessage
object
2 properties
AgentSwapWebhookSetting
string
SmsContentInferred
object
2 properties
ModelChoice
NodeBaseCommon
object
4 properties 1 required
ModelChoiceCascading
object
3 properties 2 required
CancelTransferTool
object
6 properties 2 required
TransferFailedEdge
ExtractDynamicVariableTool
object
4 properties 4 required
SmsContent
FinetuneExampleUtterance
CustomTool
object
16 properties 3 required
SubagentNode
BooleanAnalysisData
object
5 properties 3 required
Equation
object
3 properties 2 required
ConversationFlowComponent
object
7 properties
PromptCondition
object
2 properties 2 required
EnumAnalysisData
object
6 properties 4 required
ConversationFlowComponentResponse
Tool
TransferDestinationInferred
object
2 properties 2 required
ComponentNode
BookAppointmentCalTool
object
6 properties 4 required
NodeFinetuneConversationExample
object
2 properties 2 required
NodeInstructionStaticText
object
2 properties 2 required
LLMModel
string
Available LLM models for agents.
CancelTransferNode
BranchNode
PressDigitTool
object
4 properties 2 required
KBConfig
object
2 properties
SmsContentTemplate
object
2 properties 2 required
SmsContentPredefined
object
2 properties
BridgeTransferNode
AgentVersionReference
Agent version reference. Supports a numeric version (for example 3) or a tag/environment name (for example "prod"). When a tag is provided, resolution uses tha…
AlwaysEdge
WarmTransferPrompt
object
2 properties
EndCallTool
object
6 properties 2 required
BridgeTransferTool
object
6 properties 2 required
SmsInstructionTemplate
object
2 properties 2 required
StringAnalysisData
object
6 properties 3 required
AnalysisData
PostCallAnalysisSetting
string
NodeBase
Note
object
4 properties 4 required
MCP
object
5 properties 2 required
NodeEdge
object
3 properties 2 required
AgentOverrideConfig
object
4 properties
CodeTool
object
11 properties 3 required
CheckAvailabilityCalTool
object
6 properties 4 required
SmsFailedEdge
MCPTool
object
11 properties 3 required
ElseEdge
SmsSuccessEdge
PressDigitNode
AgentSwapTool
object
12 properties 4 required
GlobalNodeFinetuneTransitionExample
object
1 property 1 required
CodeNode
TransferCallTool
object
10 properties 4 required
TransferDestinationPredefined
object
3 properties 2 required
NodeTool
ToolParameter
object
The parameters the functions accepts, described as a JSON Schema object. See [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for do…
3 properties 2 required
TransferDestination
EndNode
ConversationNode
SendSMSTool
object
7 properties 3 required
GlobalNodeSetting
object
5 properties 1 required
ConversationFlowNode
NodeInstructionPrompt
object
2 properties 2 required
SmsNode
TransferOptionWarmTransfer
object
10 properties 1 required
TransferOptionAgenticWarmTransfer
object
7 properties 2 required
CreateConversationFlowComponentRequest
MCPNode
TransferOption
ExtractDynamicVariablesNode
SkipResponseEdge
NodeInstruction
NumberAnalysisData
object
5 properties 3 required
NodeFinetuneTransitionExample
object
3 properties 2 required
TransferCallNode
EquationCondition
object
3 properties 3 required
AgentSwapNode

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

retell-ai-create-conversation-flow-component-api-openapi.yml Raw ↑

Other APIs Retell AI publishes across the network.

Retell AI Add Community Voice API
Retell AI Add Knowledge Base Sources API
Retell AI Agent Playground Completion API
Retell AI Clone Voice API
Retell AI Create Agent API
Retell AI Create Agent Version API
Retell AI Create Batch Call API
Retell AI Create Batch Test API
Retell AI Create Chat Agent API
Retell AI Create Chat API
Retell AI Create Chat Completion API
Retell AI Create Conversation Flow API