> ## Documentation Index > Fetch the complete documentation index at: https://docs.retellai.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Conversation Flow > Update an existing conversation flow ## OpenAPI ````yaml openapi-final patch /update-conversation-flow/{conversation_flow_id} openapi: 3.0.3 info: title: Retell SDK version: 3.0.0 contact: name: Retell Support url: https://www.retellai.com/ email: support@retellai.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.retellai.com description: The production server. security: - api_key: [] paths: /update-conversation-flow/{conversation_flow_id}: patch: description: Update an existing conversation flow operationId: updateConversationFlow parameters: - in: path name: conversation_flow_id schema: type: string required: true description: Unique id of the conversation flow to be updated. - in: query name: version schema: type: integer example: 1 required: false description: >- Optional version of the conversation flow to update. Default to latest version. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConversationFlow' responses: '200': description: Successfully updated the conversation flow content: application/json: schema: $ref: '#/components/schemas/ConversationFlowResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/UnprocessableContent' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: JavaScript source: >- import Retell from 'retell-sdk'; const client = new Retell({ apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted }); const conversationFlowResponse = await client.conversationFlow.update('conversation_flow_id'); console.log(conversationFlowResponse.conversation_flow_id); - lang: Python source: |- import os from retell import Retell client = Retell( api_key=os.environ.get("RETELL_API_KEY"), # This is the default and can be omitted ) conversation_flow_response = client.conversation_flow.update( conversation_flow_id="conversation_flow_id", ) print(conversation_flow_response.conversation_flow_id) components: schemas: ConversationFlow: allOf: - $ref: '#/components/schemas/ConversationFlowOverride' - type: object properties: global_prompt: type: string example: You are a helpful customer service agent. description: Global prompt used in every node of the conversation flow. nullable: true tools: type: array items: $ref: '#/components/schemas/NodeTool' description: Tools available in the conversation flow. 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 nullable: true components: type: array items: $ref: '#/components/schemas/CreateConversationFlowComponentRequest' description: Local components embedded within the conversation flow. nullable: true start_node_id: type: string example: start description: ID of the start node in the conversation flow. nullable: true default_dynamic_variables: type: object additionalProperties: type: string example: company_name: Retell Inc support_hours: 9 AM - 5 PM description: >- Default dynamic variables that can be referenced throughout the conversation flow. nullable: true begin_tag_display_position: type: object properties: x: type: number example: 100 'y': type: number example: 200 description: Display position for the begin tag in the frontend. nullable: true notes: type: array items: $ref: '#/components/schemas/Note' description: Visual annotations displayed on the flow canvas. nullable: true mcps: type: array items: $ref: '#/components/schemas/MCP' description: >- A list of MCP server configurations to use for this conversation flow. nullable: true is_transfer_llm: type: boolean example: false description: Whether this conversation flow is used for transfer LLM. nullable: true nodes: type: array items: $ref: '#/components/schemas/ConversationFlowNode' description: Array of nodes in the conversation flow. example: - 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 ConversationFlowResponse: allOf: - $ref: '#/components/schemas/ConversationFlow' - type: object required: - conversation_flow_id - version properties: conversation_flow_id: type: string description: Unique identifier for the conversation flow version: type: integer description: Version number of the conversation flow ConversationFlowOverride: type: object description: >- Override properties for conversation flow configuration in agent override requests. properties: model_choice: $ref: '#/components/schemas/ModelChoice' description: The model choice for the conversation flow. model_temperature: type: number minimum: 0 maximum: 1 example: 0.7 description: >- Controls the randomness of the model's responses. Lower values make responses more deterministic. nullable: true tool_call_strict_mode: type: boolean example: true description: >- Whether to use strict mode for tool calls. Only applicable when using certain supported models. nullable: true knowledge_base_ids: type: array items: type: string example: - kb_001 - kb_002 description: Knowledge base IDs for RAG (Retrieval-Augmented Generation). nullable: true kb_config: $ref: '#/components/schemas/KBConfig' type: object description: Knowledge base configuration for RAG retrieval. start_speaker: type: string enum: - user - agent example: agent description: Who starts the conversation - user or agent. begin_after_user_silence_ms: type: integer example: 2000 description: >- If set, the AI will begin the conversation after waiting for the user for the duration (in milliseconds) specified by this attribute. This only applies if the agent is configured to wait for the user to speak first. If not set, the agent will wait indefinitely for the user to speak. nullable: true NodeTool: allOf: - oneOf: - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/CheckAvailabilityCalTool' - $ref: '#/components/schemas/BookAppointmentCalTool' - type: object required: - tool_id properties: tool_id: type: string description: Unique identifier for the tool CreateConversationFlowComponentRequest: allOf: - $ref: '#/components/schemas/ConversationFlowComponent' - type: object required: - name - nodes Note: type: object required: - id - content - display_position - size properties: id: type: string description: Unique identifier for the note. example: note_abc123 content: type: string description: >- Text content of the note, can contain refs to images in the format "" example: Remember to handle edge cases here. display_position: type: object properties: x: type: number example: 300 'y': type: number example: 150 description: Position of the note on the canvas. size: type: object properties: width: type: number example: 200 height: type: number example: 100 description: Dimensions of the note on the canvas. MCP: type: object properties: name: type: string url: type: string description: The URL of the MCP server. headers: type: object additionalProperties: type: string example: Authorization: Bearer 1234567890 description: Headers to add to the MCP connection request. query_params: type: object additionalProperties: type: string example: index: '1' key: value description: Query parameters to append to the MCP connection request URL. timeout_ms: type: integer description: >- Maximum time to wait for a connection to be established (in milliseconds). Default to 120,000 ms (2 minutes). required: - name - url ConversationFlowNode: oneOf: - $ref: '#/components/schemas/ConversationNode' - $ref: '#/components/schemas/SubagentNode' - $ref: '#/components/schemas/EndNode' - $ref: '#/components/schemas/FunctionNode' - $ref: '#/components/schemas/CodeNode' - $ref: '#/components/schemas/TransferCallNode' - $ref: '#/components/schemas/PressDigitNode' - $ref: '#/components/schemas/BranchNode' - $ref: '#/components/schemas/SmsNode' - $ref: '#/components/schemas/ExtractDynamicVariablesNode' - $ref: '#/components/schemas/AgentSwapNode' - $ref: '#/components/schemas/MCPNode' - $ref: '#/components/schemas/ComponentNode' - $ref: '#/components/schemas/BridgeTransferNode' - $ref: '#/components/schemas/CancelTransferNode' ModelChoice: oneOf: - $ref: '#/components/schemas/ModelChoiceCascading' KBConfig: type: object properties: top_k: type: integer minimum: 1 maximum: 10 example: 3 description: Max number of knowledge base chunks to retrieve filter_score: type: number minimum: 0 maximum: 1 example: 0.6 description: Similarity threshold for filtering search results CustomTool: type: object properties: type: type: string enum: - custom name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state edges). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). url: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. description: type: string description: Describes what this tool does and when to call this tool. method: type: string enum: - GET - POST - PUT - PATCH - DELETE description: Method to use for the request, default to POST. headers: type: object additionalProperties: type: string example: Authorization: Bearer 1234567890 description: Headers to add to the request. query_params: type: object additionalProperties: type: string example: page: '1' sort: asc description: Query parameters to append to the request URL. parameters: $ref: '#/components/schemas/ToolParameter' response_variables: type: object additionalProperties: type: string example: user_name: data.user.name description: >- A mapping of variable names to JSON paths in the response body. These values will be extracted from the response and made available as dynamic variables for use. speak_during_execution: type: boolean description: >- Determines whether the agent would say sentence like "One moment, let me check that." when executing the function. Recommend to turn on if your function call takes over 1s (including network) to complete, so that your agent remains responsive. speak_after_execution: type: boolean description: >- Determines whether the agent would call LLM another time and speak when the result of function is obtained. Usually this needs to get turned on so user can get update for the function call. execution_message_description: type: string description: >- The description for the sentence agent say during execution. Only applicable when speak_during_execution is true. Can write what to say or even provide examples. The default is "The message you will say to callee when calling this tool. Make sure it fits into the conversation smoothly.". execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". timeout_ms: type: integer description: >- The maximum time in milliseconds the tool can run before it's considered timeout. If the tool times out, the agent would have that info. The minimum value allowed is 1000 ms (1 s), and maximum value allowed is 600,000 ms (10 min). By default, this is set to 120,000 ms (2 min). args_at_root: type: boolean description: >- If set to true, the parameters will be passed as root level JSON object instead of nested under "args". enable_typing_sound: type: boolean description: >- If true, play a typing sound on the agent audio track while this tool is executing. Useful when the tool takes a noticeable amount of time to prevent silence on the call. required: - type - name - url CheckAvailabilityCalTool: type: object properties: type: type: string enum: - check_availability_cal name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state transitions). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. cal_api_key: type: string description: >- Cal.com Api key that have access to the cal.com event you want to check availability for. event_type_id: oneOf: - type: number - type: string description: >- Cal.com event type id number for the cal.com event you want to check availability for. Can be a number or a dynamic variable in the format `{{variable_name}}` that will be resolved at runtime. timezone: type: string description: >- Timezone to be used when checking availability, must be in [IANA timezone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Can also be a dynamic variable in the format `{{variable_name}}` that will be resolved at runtime. If not specified, will check if user specified timezone in call, and if not, will use the timezone of the Retell servers. required: - type - name - cal_api_key - event_type_id BookAppointmentCalTool: type: object properties: type: type: string enum: - book_appointment_cal name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state transitions). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. cal_api_key: type: string description: >- Cal.com Api key that have access to the cal.com event you want to book appointment. event_type_id: oneOf: - type: number - type: string description: >- Cal.com event type id number for the cal.com event you want to book appointment. Can be a number or a dynamic variable in the format `{{variable_name}}` that will be resolved at runtime. timezone: type: string description: >- Timezone to be used when booking appointment, must be in [IANA timezone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Can also be a dynamic variable in the format `{{variable_name}}` that will be resolved at runtime. If not specified, will check if user specified timezone in call, and if not, will use the timezone of the Retell servers. required: - type - name - cal_api_key - event_type_id ConversationFlowComponent: type: object properties: name: type: string description: Name of the component example: Customer Information Collector tools: type: array items: $ref: '#/components/schemas/NodeTool' description: Tools available within the component 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 nullable: true mcps: type: array items: $ref: '#/components/schemas/MCP' description: A list of MCP server configurations to use for this component nullable: true nodes: type: array items: $ref: '#/components/schemas/ConversationFlowNode' description: Nodes that make up the component example: - id: collect_info type: conversation instruction: type: prompt text: Ask the customer for their name and contact information. start_node_id: type: string description: ID of the starting node example: collect_info nullable: true begin_tag_display_position: type: object properties: x: type: number example: 100 'y': type: number example: 200 description: Display position for the begin tag in the frontend nullable: true notes: type: array items: $ref: '#/components/schemas/Note' description: Visual annotations displayed on the flow canvas. nullable: true ConversationNode: allOf: - $ref: '#/components/schemas/NodeBase' - $ref: '#/components/schemas/AgentOverrideConfig' - type: object required: - type - instruction properties: type: type: string enum: - conversation description: Type of the node instruction: $ref: '#/components/schemas/NodeInstruction' skip_response_edge: $ref: '#/components/schemas/SkipResponseEdge' always_edge: $ref: '#/components/schemas/AlwaysEdge' edges: type: array items: $ref: '#/components/schemas/NodeEdge' finetune_conversation_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneConversationExample' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' knowledge_base_ids: type: array items: type: string example: - kb_001 - kb_002 description: Knowledge base IDs for RAG (Retrieval-Augmented Generation). nullable: true kb_config: $ref: '#/components/schemas/KBConfig' type: object description: >- Knowledge base configuration for RAG retrieval at the node level. If kb_instruction is set here, it overrides the flow-level kb_instruction. SubagentNode: allOf: - $ref: '#/components/schemas/NodeBase' - $ref: '#/components/schemas/AgentOverrideConfig' - type: object required: - type - instruction properties: type: type: string enum: - subagent description: Type of the node instruction: $ref: '#/components/schemas/NodeInstructionPrompt' skip_response_edge: $ref: '#/components/schemas/SkipResponseEdge' always_edge: $ref: '#/components/schemas/AlwaysEdge' edges: type: array items: $ref: '#/components/schemas/NodeEdge' finetune_conversation_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneConversationExample' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' knowledge_base_ids: type: array items: type: string description: Knowledge base IDs for RAG (Retrieval-Augmented Generation). nullable: true kb_config: $ref: '#/components/schemas/KBConfig' type: object description: >- Knowledge base configuration for RAG retrieval at the node level. If kb_instruction is set here, it overrides the flow-level kb_instruction. tool_ids: type: array items: type: string description: >- The tool ids of the tools defined in main conversation flow or component that can be used in this subagent node. nullable: true tools: type: array items: $ref: '#/components/schemas/Tool' description: >- The tools owned by this subagent node. This includes other tool types like transfer_call, agent_swap, etc. nullable: true EndNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type properties: type: type: string enum: - end description: Type of the node speak_during_execution: type: boolean description: If true, will speak during execution instruction: $ref: '#/components/schemas/NodeInstruction' description: >- What to say when ending the call, only used when speak during execution FunctionNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - tool_id - tool_type - wait_for_result properties: type: type: string enum: - function description: Type of the node tool_id: type: string description: Tool ID for function nodes tool_type: type: string enum: - local - shared description: Tool type for function nodes speak_during_execution: type: boolean description: Whether to speak during tool execution instruction: $ref: '#/components/schemas/NodeInstruction' wait_for_result: type: boolean description: Whether to wait for tool result enable_typing_sound: type: boolean description: If true, play a typing sound while this function executes. edges: type: array items: $ref: '#/components/schemas/NodeEdge' else_edge: $ref: '#/components/schemas/ElseEdge' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' CodeNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - code - wait_for_result properties: type: type: string enum: - code description: Type of the node code: type: string maxLength: 20000 description: JavaScript code to execute in the sandbox. timeout_ms: type: integer minimum: 5000 maximum: 60000 description: >- The maximum time in milliseconds the code can run before it's considered timeout. Defaults to 30,000 ms (30 s). response_variables: type: object additionalProperties: type: string example: order_id: data.order.id description: >- A mapping of variable names to JSON paths in the code execution result. These mapped values will be extracted and added as dynamic variables. speak_during_execution: type: boolean description: Whether to speak during code execution instruction: $ref: '#/components/schemas/NodeInstruction' wait_for_result: type: boolean description: Whether to wait for code execution result enable_typing_sound: type: boolean description: If true, play a typing sound while code executes. edges: type: array items: $ref: '#/components/schemas/NodeEdge' else_edge: $ref: '#/components/schemas/ElseEdge' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' TransferCallNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - transfer_destination - transfer_option - edge properties: type: type: string enum: - transfer_call description: Type of the node transfer_destination: $ref: '#/components/schemas/TransferDestination' ignore_e164_validation: type: boolean description: >- If true, the e.164 validation will be ignored for the from_number. This can be useful when you want to dial to internal pseudo numbers. This only applies when you are using custom telephony and does not apply when you are using Retell Telephony. If omitted, the default value is false. example: false custom_sip_headers: type: object additionalProperties: type: string description: Custom SIP headers for transfer calls transfer_option: $ref: '#/components/schemas/TransferOption' type: object edge: $ref: '#/components/schemas/TransferFailedEdge' speak_during_execution: type: boolean description: If true, will speak during execution instruction: $ref: '#/components/schemas/NodeInstruction' description: >- What to say when transferring the call, only used when speak during execution PressDigitNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - instruction properties: type: type: string enum: - press_digit description: Type of the node instruction: $ref: '#/components/schemas/NodeInstructionPrompt' delay_ms: type: integer description: Delay in milliseconds before pressing the digit edges: type: array items: $ref: '#/components/schemas/NodeEdge' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' BranchNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - else_edge properties: type: type: string enum: - branch description: Type of the node edges: type: array items: $ref: '#/components/schemas/NodeEdge' else_edge: $ref: '#/components/schemas/ElseEdge' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' SmsNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - instruction - success_edge - failed_edge properties: type: type: string enum: - sms description: Type of the node instruction: oneOf: - $ref: '#/components/schemas/NodeInstruction' - $ref: '#/components/schemas/SmsInstructionTemplate' success_edge: $ref: '#/components/schemas/SmsSuccessEdge' failed_edge: $ref: '#/components/schemas/SmsFailedEdge' ExtractDynamicVariablesNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - variables properties: type: type: string enum: - extract_dynamic_variables description: Type of the node variables: type: array items: $ref: '#/components/schemas/AnalysisData' edges: type: array items: $ref: '#/components/schemas/NodeEdge' else_edge: $ref: '#/components/schemas/ElseEdge' finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' AgentSwapNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - agent_id - post_call_analysis_setting - edge properties: type: type: string enum: - agent_swap description: Type of the node agent_id: type: string description: The ID of the agent to swap to agent_version: $ref: '#/components/schemas/AgentVersionReference' description: >- The version of the agent to swap to. If not specified, will use the latest version post_call_analysis_setting: $ref: '#/components/schemas/PostCallAnalysisSetting' description: Post call analysis setting for the agent swap webhook_setting: $ref: '#/components/schemas/AgentSwapWebhookSetting' description: Webhook setting for the agent swap, defaults to only source. keep_current_voice: type: boolean description: >- If true, keep the current voice when swapping agents. Defaults to false. keep_current_language: type: boolean description: >- If true, keep the current language when swapping agents. Defaults to false. edge: $ref: '#/components/schemas/TransferFailedEdge' description: Edge to transition to if agent swap fails speak_during_execution: type: boolean description: If true, will speak during execution instruction: $ref: '#/components/schemas/NodeInstruction' description: >- What to say when swapping agents, only used when speak during execution MCPNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type - mcp_id - mcp_tool_name - wait_for_result properties: type: type: string enum: - mcp description: Type of the node mcp_id: type: string description: Unique ID of the MCP server mcp_tool_name: type: string description: Name of the MCP tool to call edges: type: array items: $ref: '#/components/schemas/NodeEdge' else_edge: $ref: '#/components/schemas/ElseEdge' response_variables: type: object additionalProperties: type: string description: >- Response variables to add to dynamic variables, key is the variable name, value is the path to the variable in the response speak_during_execution: type: boolean description: If true, will speak during execution instruction: $ref: '#/components/schemas/NodeInstruction' description: >- What to say when calling the function, only used when speak during execution wait_for_result: type: boolean description: If true, will wait for result before transitioning to next node enable_typing_sound: type: boolean description: If true, play a typing sound while MCP tool executes. finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' ComponentNode: allOf: - $ref: '#/components/schemas/NodeBaseCommon' - type: object required: - type - component_id - component_type - else_edge properties: type: type: string enum: - component description: Type of the node component_id: type: string description: The reference ID of the component component_type: type: string enum: - local - shared description: > Type of component: - local: stored in conversation flow's components array - shared: stored in stand-alone conversation-flow-component table edges: type: array items: $ref: '#/components/schemas/NodeEdge' description: Array of edges for conditional transitions else_edge: $ref: '#/components/schemas/ElseEdge' description: Default edge when no other conditions are met finetune_transition_examples: type: array items: $ref: '#/components/schemas/NodeFinetuneTransitionExample' BridgeTransferNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type properties: type: type: string enum: - bridge_transfer description: >- Type of the node - initiates a warm transfer by bridging the call speak_during_execution: type: boolean description: If true, will speak during execution instruction: $ref: '#/components/schemas/NodeInstruction' description: >- Describes what to say to user when bridging the transfer. Only applicable when speak_during_execution is true. CancelTransferNode: allOf: - $ref: '#/components/schemas/NodeBase' - type: object required: - type properties: type: type: string enum: - cancel_transfer description: >- Type of the node - cancels the warm transfer and ends the transfer agent call speak_during_execution: type: boolean description: If true, will speak during execution instruction: $ref: '#/components/schemas/NodeInstruction' description: >- Describes what to say to user when cancelling the transfer. Only applicable when speak_during_execution is true. ModelChoiceCascading: type: object required: - type - model properties: type: type: string enum: - cascading description: Type of model choice model: $ref: '#/components/schemas/LLMModel' description: The LLM model to use high_priority: type: boolean description: >- Whether to use high priority pool with more dedicated resource, default false ToolParameter: type: object description: >- The parameters the functions accepts, described as a JSON Schema object. See [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting parameters defines a function with an empty parameter list. required: - type - properties properties: type: type: string enum: - object description: Type must be "object" for a JSON Schema object. properties: type: object additionalProperties: {} description: >- The value of properties is an object, where each key is the name of a property and each value is a schema used to validate that property. required: type: array items: type: string description: >- List of names of required property when generating this parameter. LLM will do its best to generate the required properties in its function arguments. Property must exist in properties. NodeBase: allOf: - $ref: '#/components/schemas/NodeBaseCommon' - type: object properties: model_choice: $ref: '#/components/schemas/ModelChoice' AgentOverrideConfig: type: object properties: interruption_sensitivity: type: number minimum: 0 maximum: 1 nullable: true responsiveness: type: number minimum: 0 maximum: 1 nullable: true voice_speed: type: number minimum: 0.5 maximum: 2 nullable: true allow_dtmf_interruption: type: boolean nullable: true description: >- If set, overrides the agent-level allow_dtmf_interruption for this node only. NodeInstruction: oneOf: - $ref: '#/components/schemas/NodeInstructionPrompt' - $ref: '#/components/schemas/NodeInstructionStaticText' SkipResponseEdge: allOf: - $ref: '#/components/schemas/NodeEdge' - type: object required: - transition_condition properties: transition_condition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string enum: - Skip response description: Must be "Skip response" for skip response edge AlwaysEdge: allOf: - $ref: '#/components/schemas/NodeEdge' - type: object required: - transition_condition properties: transition_condition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string enum: - Always description: Must be "Always" for always edge NodeEdge: type: object required: - id - transition_condition properties: id: type: string description: Unique identifier for the edge transition_condition: oneOf: - $ref: '#/components/schemas/PromptCondition' - $ref: '#/components/schemas/EquationCondition' destination_node_id: type: string description: ID of the destination node NodeFinetuneConversationExample: type: object required: - id - transcript properties: id: type: string description: Unique identifier for the example transcript: type: array items: $ref: '#/components/schemas/FinetuneExampleUtterance' description: The example transcript to finetune how the conversation should be. NodeFinetuneTransitionExample: type: object required: - id - transcript properties: id: type: string description: Unique identifier for the example transcript: type: array items: $ref: '#/components/schemas/FinetuneExampleUtterance' description: The example transcript to finetune how the node should transition. destination_node_id: type: string description: Optional destination node ID NodeInstructionPrompt: type: object required: - type - text properties: type: type: string enum: - prompt description: Type of instruction text: type: string description: The prompt text for the instruction Tool: oneOf: - $ref: '#/components/schemas/EndCallTool' - $ref: '#/components/schemas/TransferCallTool' - $ref: '#/components/schemas/CheckAvailabilityCalTool' - $ref: '#/components/schemas/BookAppointmentCalTool' - $ref: '#/components/schemas/AgentSwapTool' - $ref: '#/components/schemas/PressDigitTool' - $ref: '#/components/schemas/SendSMSTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/CodeTool' - $ref: '#/components/schemas/ExtractDynamicVariableTool' - $ref: '#/components/schemas/BridgeTransferTool' - $ref: '#/components/schemas/CancelTransferTool' - $ref: '#/components/schemas/MCPTool' ElseEdge: allOf: - $ref: '#/components/schemas/NodeEdge' - type: object required: - transition_condition properties: transition_condition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string enum: - Else description: Must be "Else" for else edge TransferDestination: oneOf: - $ref: '#/components/schemas/TransferDestinationPredefined' - $ref: '#/components/schemas/TransferDestinationInferred' TransferOption: oneOf: - $ref: '#/components/schemas/TransferOptionColdTransfer' - $ref: '#/components/schemas/TransferOptionWarmTransfer' - $ref: '#/components/schemas/TransferOptionAgenticWarmTransfer' x-mintlify-name: Transfer Options TransferFailedEdge: allOf: - $ref: '#/components/schemas/NodeEdge' - type: object required: - transition_condition properties: transition_condition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string enum: - Transfer failed description: Must be "Transfer failed" for transfer failed edge SmsInstructionTemplate: type: object required: - type - template properties: type: type: string enum: - template description: Type of instruction template: type: string enum: - info_collection description: >- The template to use for the instruction. "info_collection" sends a predefined message requesting information from the user. SmsSuccessEdge: allOf: - $ref: '#/components/schemas/NodeEdge' - type: object required: - transition_condition properties: transition_condition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string enum: - Sent successfully description: Must be "sent successfully" for SMS success edge SmsFailedEdge: allOf: - $ref: '#/components/schemas/NodeEdge' - type: object required: - transition_condition properties: transition_condition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string enum: - Failed to send description: Must be "failed to send" for SMS failed edge AnalysisData: oneOf: - $ref: '#/components/schemas/StringAnalysisData' - $ref: '#/components/schemas/EnumAnalysisData' - $ref: '#/components/schemas/BooleanAnalysisData' - $ref: '#/components/schemas/NumberAnalysisData' AgentVersionReference: oneOf: - type: integer minimum: 0 example: 1 - type: string minLength: 1 maxLength: 20 pattern: ^[a-z0-9_-]+$ example: prod description: >- 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 that exact tag assignment (including its dynamic variables). If the tag exists but is currently unassigned, it resolves to latest. When a numeric version (or latest) is provided, resolution applies dynamic variables from the preferred tag for that resolved version (most recently assigned), if any. PostCallAnalysisSetting: type: string enum: - both_agents - only_destination_agent AgentSwapWebhookSetting: type: string enum: - both_agents - only_destination_agent - only_source_agent NodeBaseCommon: type: object required: - id properties: id: type: string description: Unique identifier for the node name: type: string description: Optional name for display purposes global_node_setting: $ref: '#/components/schemas/GlobalNodeSetting' display_position: type: object properties: x: type: number 'y': type: number description: Position for frontend display LLMModel: type: string enum: - gpt-4.1 - gpt-4.1-mini - gpt-4.1-nano - gpt-5 - gpt-5-mini - gpt-5-nano - gpt-5.1 - gpt-5.2 - gpt-5.4 - gpt-5.4-mini - gpt-5.4-nano - gpt-5.5 - claude-4.5-sonnet - claude-4.6-sonnet - claude-4.5-haiku - gemini-2.5-flash-lite - gemini-3.0-flash - gemini-3.1-flash-lite description: Available LLM models for agents. NodeInstructionStaticText: type: object required: - type - text properties: type: type: string enum: - static_text description: Type of instruction text: type: string description: The static text for the instruction PromptCondition: type: object required: - type - prompt properties: type: type: string enum: - prompt prompt: type: string description: Prompt condition text EquationCondition: type: object required: - type - equations - operator properties: type: type: string enum: - equation equations: type: array maxItems: 50 items: $ref: '#/components/schemas/Equation' operator: type: string enum: - '||' - '&&' FinetuneExampleUtterance: oneOf: - type: object required: - role - content properties: role: type: string enum: - agent - user content: type: string - type: object required: - role - tool_call_id - name - arguments properties: role: type: string enum: - tool_call_invocation tool_call_id: type: string name: type: string arguments: type: string - type: object required: - role - tool_call_id - content properties: role: type: string enum: - tool_call_result tool_call_id: type: string content: type: string EndCallTool: type: object properties: type: type: string enum: - end_call name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state transitions). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. speak_during_execution: type: boolean description: If true, will speak during execution. execution_message_description: type: string description: >- Describes what to say to user when ending the call. Only applicable when speak_during_execution is true. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". required: - type - name TransferCallTool: type: object properties: type: type: string enum: - transfer_call name: type: string example: transfer_to_support description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state edges). description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. transfer_destination: $ref: '#/components/schemas/TransferDestination' type: object ignore_e164_validation: type: boolean description: >- If true, the e.164 validation will be ignored for the from_number. This can be useful when you want to dial to internal pseudo numbers. This only applies when you are using custom telephony and does not apply when you are using Retell Telephony. If omitted, the default value is false. example: false custom_sip_headers: type: object additionalProperties: type: string example: X-Custom-Header: Custom Value description: Custom SIP headers to be added to the call. transfer_option: $ref: '#/components/schemas/TransferOption' type: object speak_during_execution: type: boolean description: If true, will speak during execution. execution_message_description: type: string description: >- Describes what to say to user when transferring the call. Only applicable when speak_during_execution is true. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". required: - type - name - transfer_destination - transfer_option AgentSwapTool: type: object properties: name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state edges). type: type: string enum: - agent_swap description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. agent_id: type: string minLength: 1 description: The id of the agent to swap to. agent_version: $ref: '#/components/schemas/AgentVersionReference' description: >- The version of the agent to swap to. If not specified, will use the latest version. speak_during_execution: type: boolean execution_message_description: type: string description: The message for the agent to speak when executing agent swap. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". post_call_analysis_setting: $ref: '#/components/schemas/PostCallAnalysisSetting' description: Post call analysis setting for the agent swap. webhook_setting: $ref: '#/components/schemas/AgentSwapWebhookSetting' description: Webhook setting for the agent swap, defaults to only source. keep_current_voice: type: boolean description: >- If true, keep the current voice when swapping agents. Defaults to false. keep_current_language: type: boolean description: >- If true, keep the current language when swapping agents. Defaults to false. required: - type - name - agent_id - post_call_analysis_setting PressDigitTool: type: object properties: type: type: string enum: - press_digit name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state transitions). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. delay_ms: type: integer description: >- Delay in milliseconds before pressing the digit, because a lot of IVR systems speak very slowly, and a delay can make sure the agent hears the full menu. Default to 1000 ms (1s). Valid range is 0 to 5000 ms (inclusive). required: - type - name SendSMSTool: type: object properties: name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state edges). type: type: string enum: - send_sms description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. speak_during_execution: type: boolean description: >- If true, the agent will speak a short line before sending the SMS. If omitted, defaults to true (same as end_call / transfer_call tools). execution_message_description: type: string description: >- Describes what to say before sending the SMS. Only applicable when speak_during_execution is true. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". sms_content: $ref: '#/components/schemas/SmsContent' required: - type - name - sms_content CodeTool: type: object properties: type: type: string enum: - code name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state edges). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: Describes what this tool does and when to call this tool. code: type: string maxLength: 20000 description: JavaScript code to execute in the sandbox. timeout_ms: type: integer minimum: 5000 maximum: 60000 description: >- The maximum time in milliseconds the code can run before it's considered timeout. Defaults to 30,000 ms (30 s). response_variables: type: object additionalProperties: type: string example: order_id: data.order.id description: >- A mapping of variable names to JSON paths in the code execution result. These mapped values will be extracted and added as dynamic variables. speak_during_execution: type: boolean description: >- Determines whether the agent would say sentence like "One moment, let me check that." when executing the tool. speak_after_execution: type: boolean default: true description: >- Determines whether the agent would call LLM another time and speak when the result of function is obtained. execution_message_description: type: string description: >- The description for the sentence agent say during execution. Only applicable when speak_during_execution is true. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". enable_typing_sound: type: boolean description: >- If true, play a typing sound on the agent audio track while this tool is executing. required: - type - name - code ExtractDynamicVariableTool: type: object properties: type: type: string enum: - extract_dynamic_variable name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state edges). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does, sometimes can also include information about when to call the tool. variables: type: array items: $ref: '#/components/schemas/AnalysisData' description: The variables to be extracted. required: - type - name - variables - description BridgeTransferTool: type: object properties: type: type: string enum: - bridge_transfer name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state transitions). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does. This tool is only available to transfer agents (agents with isTransferAgent set to true) in agentic warm transfer mode. When invoked, it bridges the original caller to the transfer target and ends the transfer agent call. speak_during_execution: type: boolean description: If true, will speak during execution. execution_message_description: type: string description: >- Describes what to say to user when bridging the transfer. Only applicable when speak_during_execution is true. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". required: - type - name CancelTransferTool: type: object properties: type: type: string enum: - cancel_transfer name: type: string description: >- Name of the tool. Must be unique within all tools available to LLM at any given time (general tools + state tools + state transitions). Must be consisted of a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64 (no space allowed). description: type: string description: >- Describes what the tool does. This tool is only available to transfer agents (agents with isTransferAgent set to true) in agentic warm transfer mode. When invoked, it cancels the transfer, returns the original caller to the main agent, and ends the transfer agent call. speak_during_execution: type: boolean description: If true, will speak during execution. execution_message_description: type: string description: >- Describes what to say to user when cancelling the transfer. Only applicable when speak_during_execution is true. execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". required: - type - name MCPTool: type: object properties: type: type: string enum: - mcp mcp_id: type: string description: Unique id of the MCP. name: type: string description: Name of the MCP tool. description: type: string description: Description of the MCP tool. input_schema: type: object additionalProperties: type: string description: The input schema of the MCP tool. response_variables: type: object additionalProperties: type: string description: >- Response variables to add to dynamic variables, key is the variable name, value is the path to the variable in the response speak_during_execution: type: boolean description: >- Determines whether the agent would say sentence like "One moment, let me check that." when executing the function. Recommend to turn on if your function call takes over 1s (including network) to complete, so that your agent remains responsive. speak_after_execution: type: boolean description: >- Determines whether the agent would call LLM another time and speak when the result of function is obtained. Usually this needs to get turned on so user can get update for the function call. execution_message_description: type: string description: >- The description for the sentence agent say during execution. Only applicable when speak_during_execution is true. Can write what to say or even provide examples. The default is "The message you will say to callee when calling this tool. Make sure it fits into the conversation smoothly.". execution_message_type: type: string enum: - prompt - static_text description: >- Type of execution message. "prompt" means the agent will use execution_message_description as a prompt to generate the message. "static_text" means the agent will speak the execution_message_description directly. Defaults to "prompt". enable_typing_sound: type: boolean description: >- If true, play a typing sound on the agent audio track while this MCP tool is executing. required: - type - name - description TransferDestinationPredefined: type: object properties: type: type: string enum: - predefined description: The type of transfer destination. number: type: string description: >- The number to transfer to in E.164 format or a dynamic variable like {{transfer_number}}. extension: type: string description: >- Extension digits to dial after the main number connects. Sent via DTMF. Allow digits, '*', '#', or a dynamic variable like {{extension}}. example: 123*456# required: - type - number TransferDestinationInferred: type: object properties: type: type: string enum: - inferred description: The type of transfer destination. prompt: type: string description: >- The prompt to be used to help infer the transfer destination. The model will take the global prompt, the call transcript, and this prompt together to deduce the right number to transfer to. Can contain dynamic variables. required: - type - prompt TransferOptionColdTransfer: type: object title: Cold Transfer properties: type: type: string enum: - cold_transfer description: The type of the transfer. show_transferee_as_caller: type: boolean description: >- If set to true, will show transferee (the user, not the AI agent) as caller when transferring. Requires the telephony side to support caller id override. Retell Twilio numbers support this option. This parameter takes effect only when `cold_transfer_mode` is set to `sip_invite`. When using `sip_refer`, this option is not available. Retell Twilio numbers always use user's number as the caller id when using `sip refer` cold transfer mode. cold_transfer_mode: type: string enum: - sip_refer - sip_invite description: >- The mode of the cold transfer. If set to `sip_refer`, will use SIP REFER to transfer the call. If set to `sip_invite`, will use SIP INVITE to transfer the call. default: sip_invite transfer_ring_duration_ms: type: integer minimum: 5000 maximum: 90000 description: >- Override the ring duration for this specific transfer, in milliseconds. If not set, falls back to the agent-level `ring_duration_ms`. required: - type TransferOptionWarmTransfer: type: object title: Warm Transfer properties: type: type: string enum: - warm_transfer description: The type of the transfer. show_transferee_as_caller: type: boolean description: >- If set to true, will show transferee (the user, not the AI agent) as caller when transferring, requires the telephony side to support caller id override. Retell Twilio numbers support this option. agent_detection_timeout_ms: type: number description: The time to wait before considering transfer fails. transfer_ring_duration_ms: type: integer minimum: 5000 maximum: 90000 description: >- Override the ring duration for this specific transfer, in milliseconds. If not set, falls back to the agent-level `ring_duration_ms`. on_hold_music: type: string enum: - none - relaxing_sound - uplifting_beats - ringtone description: The music to play while the caller is being transferred. public_handoff_option: type: object oneOf: - $ref: '#/components/schemas/WarmTransferPrompt' - $ref: '#/components/schemas/WarmTransferStaticMessage' description: >- If set, when transfer is successful, will say the handoff message to both the transferee and the agent receiving the transfer. Can leave either a static message or a dynamic one based on prompt. Set to null to disable warm handoff. private_handoff_option: type: object oneOf: - $ref: '#/components/schemas/WarmTransferPrompt' - $ref: '#/components/schemas/WarmTransferStaticMessage' description: >- If set, when transfer is connected, will say the handoff message only to the agent receiving the transfer. Can leave either a static message or a dynamic one based on prompt. Set to null to disable warm handoff. ivr_option: $ref: '#/components/schemas/WarmTransferPrompt' type: object description: >- IVR navigation option to run when doing human detection. This prompt will guide the AI on how to navigate the IVR system. opt_out_human_detection: type: boolean description: >- If set to true, will not perform human detection for the transfer. Default to false. enable_bridge_audio_cue: type: boolean description: >- Whether to play an audio cue when bridging the call. Defaults to true. default: true required: - type TransferOptionAgenticWarmTransfer: type: object title: Agentic Warm Transfer properties: type: type: string enum: - agentic_warm_transfer description: The type of the transfer. show_transferee_as_caller: type: boolean description: >- If set to true, will show transferee (the user, not the AI agent) as caller when transferring, requires the telephony side to support caller id override. Retell Twilio numbers support this option. on_hold_music: type: string enum: - none - relaxing_sound - uplifting_beats - ringtone description: The music to play while the caller is being transferred. transfer_ring_duration_ms: type: integer minimum: 5000 maximum: 90000 description: >- Override the ring duration for this specific transfer, in milliseconds. If not set, falls back to the agent-level `ring_duration_ms`. public_handoff_option: type: object oneOf: - $ref: '#/components/schemas/WarmTransferPrompt' - $ref: '#/components/schemas/WarmTransferStaticMessage' description: >- If set, when transfer is successful, will say the handoff message to both the transferee and the agent receiving the transfer. Can leave either a static message or a dynamic one based on prompt. Set to null to disable warm handoff. agentic_transfer_config: type: object description: >- Configuration for agentic warm transfer. Required for agentic warm transfer. properties: transfer_agent: type: object description: The agent that will mediate the transfer decision. properties: agent_id: type: string minLength: 1 description: >- The agent ID of the transfer agent. This agent must have isTransferAgent set to true and should use bridge_transfer and cancel_transfer tools (for Retell LLM) or BridgeTransferNode and CancelTransferNode (for Conversation Flow). agent_version: type: number description: The version of the transfer agent to use. required: - agent_id - agent_version transfer_timeout_ms: type: number description: >- The maximum time to wait for the transfer agent to make a decision, in milliseconds. Defaults to 30000 (30 seconds). default: 30000 action_on_timeout: type: string enum: - bridge_transfer - cancel_transfer description: >- The action to take when the transfer agent times out without making a decision. Defaults to cancel_transfer. default: cancel_transfer enable_bridge_audio_cue: type: boolean description: >- Whether to play an audio cue when bridging the call. Defaults to true. default: true required: - type - agentic_transfer_config StringAnalysisData: type: object required: - type - name - description properties: type: type: string enum: - string description: Type of the variable to extract. example: string name: type: string description: Name of the variable. example: customer_name minLength: 1 description: type: string description: Description of the variable. example: The name of the customer. examples: type: array items: type: string description: Examples of the variable value to teach model the style and syntax. example: - John Doe - Jane Smith required: type: boolean description: >- Whether this data is required. If true and the data is not extracted, the call will be marked as unsuccessful. conditional_prompt: type: string description: >- Optional instruction to help decide whether this field needs to be populated in the analysis. If not set, the field is always included. If required is true, this is ignored. EnumAnalysisData: type: object required: - type - name - description - choices properties: type: type: string enum: - enum description: Type of the variable to extract. example: enum name: type: string description: Name of the variable. example: product_rating minLength: 1 description: type: string description: Description of the variable. example: Rating of the product. choices: type: array items: type: string description: The possible values of the variable, must be non empty array. example: - good required: type: boolean description: >- Whether this data is required. If true and the data is not extracted, the call will be marked as unsuccessful. conditional_prompt: type: string description: >- Optional instruction to help decide whether this field needs to be populated in the analysis. If not set, the field is always included. If required is true, this is ignored. BooleanAnalysisData: type: object required: - type - name - description properties: type: type: string enum: - boolean description: Type of the variable to extract. example: boolean name: type: string description: Name of the variable. example: is_converted minLength: 1 description: type: string description: Description of the variable. example: Whether the customer converted. required: type: boolean description: >- Whether this data is required. If true and the data is not extracted, the call will be marked as unsuccessful. conditional_prompt: type: string description: >- Optional instruction to help decide whether this field needs to be populated in the analysis. If not set, the field is always included. If required is true, this is ignored. NumberAnalysisData: type: object required: - type - name - description properties: type: type: string enum: - number description: Type of the variable to extract. example: number name: type: string description: Name of the variable. example: order_count minLength: 1 description: type: string description: Description of the variable. example: How many the customer intend to order. required: type: boolean description: >- Whether this data is required. If true and the data is not extracted, the call will be marked as unsuccessful. conditional_prompt: type: string description: >- Optional instruction to help decide whether this field needs to be populated in the analysis. If not set, the field is always included. If required is true, this is ignored. GlobalNodeSetting: type: object required: - condition properties: condition: type: string description: Condition for global node activation, cannot be empty go_back_conditions: type: array items: $ref: '#/components/schemas/NodeEdge' description: >- The conditions for global node go back. There would be no destination_node_id for these edges. cool_down: type: number minimum: 1 description: >- The same global node won't be triggered again within the next N node transitions. positive_finetune_examples: type: array items: $ref: '#/components/schemas/GlobalNodeFinetuneTransitionExample' description: Transition to this node negative_finetune_examples: type: array items: $ref: '#/components/schemas/GlobalNodeFinetuneTransitionExample' description: Don't transition to this node Equation: type: object required: - left - operator properties: left: type: string description: Left side of the equation operator: type: string enum: - '==' - '!=' - '>' - '>=' - < - <= - contains - not_contains - exists - not_exist right: type: string description: >- Right side of the equation. The right side of the equation not required when "exists" or "not_exist" are selected. SmsContent: oneOf: - $ref: '#/components/schemas/SmsContentPredefined' - $ref: '#/components/schemas/SmsContentInferred' - $ref: '#/components/schemas/SmsContentTemplate' WarmTransferPrompt: type: object properties: type: type: string enum: - prompt prompt: type: string example: Summarize the call in one sentence for the warn handoff. description: >- The prompt to be used for warm handoff. Can contain dynamic variables. WarmTransferStaticMessage: type: object properties: type: type: string enum: - static_message message: type: string example: You can take it from here. description: >- The static message to be used for warm handoff. Can contain dynamic variables. GlobalNodeFinetuneTransitionExample: type: object required: - transcript properties: transcript: type: array items: $ref: '#/components/schemas/FinetuneExampleUtterance' description: Find tune the transition condition to this global node SmsContentPredefined: type: object properties: type: type: string enum: - predefined content: type: string description: >- The static message to be sent in the SMS. Can contain dynamic variables. SmsContentInferred: type: object properties: type: type: string enum: - inferred prompt: type: string description: >- The prompt to be used to help infer the SMS content. The model will take the global prompt, the call transcript, and this prompt together to deduce the right message to send. Can contain dynamic variables. SmsContentTemplate: type: object required: - type - template properties: type: type: string enum: - template template: type: string enum: - info_collection description: >- The template to use for the SMS content. "info_collection" sends a predefined message requesting information from the user. responses: BadRequest: description: Bad Request content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string example: Invalid request format, please check API reference. Unauthorized: description: Unauthorized content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string example: API key is missing or invalid. UnprocessableContent: description: Unprocessable Content content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string example: Cannot find requested asset under given api key. TooManyRequests: description: Too Many Requests content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string example: Account rate limited, please throttle your requests. InternalServerError: description: Internal Server Error content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string example: An unexpected server error occurred. securitySchemes: api_key: type: http scheme: bearer bearerFormat: string description: >- Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY" ````