{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/conversational-agents",
"status": 401,
"timestamp": "2026-09-28T16:34:43.684Z"
}
{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/conversational-agents",
"status": 403,
"timestamp": "2026-09-28T16:34:43.684Z"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/conversational-agents",
"status": 404,
"timestamp": "2026-09-28T16:34:43.684Z"
}
{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/conversational-agents",
"status": 500,
"timestamp": "2026-09-28T16:34:43.684Z"
}
Conversational Agents
Update conversational Agent
Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.
{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/conversational-agents",
"status": 401,
"timestamp": "2026-09-28T16:34:43.684Z"
}
{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/conversational-agents",
"status": 403,
"timestamp": "2026-09-28T16:34:43.684Z"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/conversational-agents",
"status": 404,
"timestamp": "2026-09-28T16:34:43.684Z"
}
{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/conversational-agents",
"status": 500,
"timestamp": "2026-09-28T16:34:43.684Z"
}
Authorizations
X-API-Key
string
header
required
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Path Parameters
agentId
string
required
Unique identifier of the agent to update.
Body
application/json
Request body for updating an existing conversational agent, including its start node, runtime settings, and workflow nodes.
agentName
string
Human-readable name of the agent used to identify it in the dashboard and APIs.
Maximum string length: 128
Example:
"Auralis"
startNodeName
string
The name of the node where the agent workflow starts. Must contain only letters, numbers, and underscores.
Maximum string length: 128
Pattern: ^[a-zA-Z0-9_]+$
Example:
"Welcome"
agentSettings
object
Request body for updating an existing AI agent, including its instructions, welcome message configuration, runtime settings, and available tools.
Show child attributes
nodes
object[]
The complete list of nodes that define the agent's conversational workflow. This list replaces the agent's existing nodes: nodes with a nodeId are updated, nodes without a nodeId are created, and any existing node omitted from the list is deleted.
Sends a response to the user before continuing to the next node in the workflow.
Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Show child attributes
Response
OK
agentId
string
The unique identifier of the agent within the system.
Example:
"SPIlVscbB0kkXBvZ"
agentName
string
Human-readable name of the agent used to identify it in the dashboard and APIs.
Example:
"Auralis"
startNodeName
string
The name of the node where the agent workflow starts.
Example:
"Welcome"
startNodeId
string
The unique identifier of the node where the agent workflow starts.
Example:
"node_01HXYZ123"
agentSettings
object
Configuration settings that define the agent’s runtime behavior, including voice, llm model and other operational settings.
Show child attributes
nodes
object[]
Sends a response to the user before continuing to the next node in the workflow.
Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SigmaMind AI","description":"Developer docs for SigmaMind AI. Build, test, and deploy AI agents that handle voice, chat, and email conversations for your contact center.","colors":{"primary":"#0F172A","light":"#F8FAFC","dark":"#1E293B"},"logo":{"light":"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/light.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=bc51a1190d0d56521defbdc28b2a0798","dark":"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/dark.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=37e6d9d7f667ee3761cc76b9ed758f6a","href":"https://www.sigmamind.ai"},"favicon":"https://mintcdn.com/sigmamindai/x8_xeWMetIJrwgEQ/favicon.svg?fit=max\u0026auto=format\u0026n=x8_xeWMetIJrwgEQ\u0026q=85\u0026s=dce3fc7f05848ac97179954ea0aac7a7","navbar":{"links":[{"href":"mailto:help@sigmamind.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.sigmamind.ai/auth/login"}},"footer":{"socials":{"x":"https://x.com/sigmamind_ai","linkedin":"https://www.linkedin.com/company/sigmamind-ai","website":"https://www.sigmamind.ai","youtube":"https://www.youtube.com/@SigmaMindAI"}},"seo":{"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-FS7QYGTFP5"},"gtm":{"tagId":"GTM-NN56PC2H"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"variables":{"BASE_URL":"https://api.sigmamind.ai"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.sigmamind.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://www.discord.com/invite/jSWGcw5Wyx"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sigmamindai","hasAudioNarration":false,"actualSubdomain":"sigmamindai","customDomains":["docs.sigmamind.ai"],"gitSource":{"type":"github","owner":"sigmamind-ai","repo":"docs","deployBranch":"dev-master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af44020e61bbc4648b97b1d","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"Documentation","count":94},{"language":"default","tag":"API Reference","count":77},{"language":"default","tag":"Build","count":37},{"language":"default","tag":"Deploy","count":14},{"language":"default","tag":"How to build conversational flow agents","count":12},{"language":"default","tag":"Tool Integrations","count":11},{"language":"default","tag":"How to build single prompt agents","count":8},{"language":"default","tag":"Add Basic Nodes","count":7},{"language":"default","tag":"How to Add tool","count":6},{"language":"default","tag":"CCAAS Integrations","count":6}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@sigmamind.ai","showHelpButton":true}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"695fb83bba37df35a996e0a8","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How do I connect my app with a voice AI agent?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:59:23.075Z","updatedAt":"2026-01-08T13:59:23.075Z","__v":0},{"_id":"695fb809ba37df35a996deb4","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How can I add a voice agent to my app or website?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:58:33.153Z","updatedAt":"2026-01-08T13:58:33.153Z","__v":0},{"_id":"695fb7adba37df35a996da58","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How do I set up a voice AI agent?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:57:01.201Z","updatedAt":"2026-01-08T13:57:01.201Z","__v":0}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/conversational-agents/update-conversational-agent","slug":"/api-reference/conversational-agents/update-conversational-agent","pageMetadata":{"openapi":"patch /v1/conversational-agents/{agentId}","title":"Update conversational Agent","description":"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.","href":"/api-reference/conversational-agents/update-conversational-agent"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"patch /v1/conversational-agents/{agentId}","title":"Update conversational Agent","description":"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.","href":"/api-reference/conversational-agents/update-conversational-agent"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Conversational Agents"],"summary":"Update conversational Agent","description":"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.","operationId":"updateConversationalAgent","parameters":["eb701746-a62e-454a-ac3d-767363d9deaa"],"requestBody":"4da5de7c-1e38-4fa2-8195-a99f029abeaa","responses":{"200":"17173af1-5bf7-49c2-95ba-48bb5646b062","400":"6b0f2446-5e26-42b6-b42c-7b642d8431a6","401":"6bffb623-11f4-401b-8902-7cc0616a8a96","403":"52caceee-3ece-4f57-a58d-19f0297acefb","404":"090fb6df-3aeb-4787-8b72-02719e0c6595","500":"e3a9cccb-7650-4a23-866e-23ba0a9c8257"},"method":"patch","type":"path","servers":["8e559e02-781a-40b4-9c1f-0150c00e3590"],"security":["942fdac5-677d-45bf-9a32-66b9441b7597"],"path":"/v1/conversational-agents/{agentId}","baseUrlOptions":["https://api.sigmamind.ai"],"title":"Update conversational Agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"eb701746-a62e-454a-ac3d-767363d9deaa":{"name":"agentId","in":"path","description":"Unique identifier of the agent to update.","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique identifier of the agent to update.","uniqueKey":"","typeLabel":"string"},"example":"agent_72e72"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"agentName":{"maxLength":128,"minLength":0,"type":"string","description":"Human-readable name of the agent used to identify it in the dashboard and APIs.","example":"Auralis","uniqueKey":"agentName","typeLabel":"string"},"startNodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"The name of the node where the agent workflow starts. Must contain only letters, numbers, and underscores.","example":"Welcome","uniqueKey":"startNodeName","typeLabel":"string"},"agentSettings":{"type":"object","properties":{"language":{"type":"string","description":"The language your customers will primarily speak during calls.","example":"en_US","default":"en_US","enum":["multi_nova3","multi_nova2","en","en_US","en_AU","en_GB","en_NZ","en_IN","hi","de","de_CH","nl","sv","sv_SE","da","da_DK","es","es_419","fr","fr_CA","pt","pt_BR","pt_PT","it","tr","no","id","bg","ca","zh","zh_CN","zh_Hans","zh_TW","zh_Hant","zh_HK","cs","et","fi","nl_BE","el","hu","ja","ko","ko_KR","lv","lt","ms","pl","ro","ru","sk","th","th_TH","uk","vi"],"uniqueKey":"agentSettings.language","typeLabel":"enum\u003cstring>"},"aiStartsConversation":{"type":"boolean","description":"If true the AI agent will initiate the conversation immediately when the call connects. If false the call will connect silently, waiting for the customer to speak first before the AI responds","example":true,"default":true,"uniqueKey":"agentSettings.aiStartsConversation","typeLabel":"boolean"},"backgroundSound":{"type":"string","description":"Add ambient background audio during the call.","example":"keyboard_typing","default":"none","enum":["keyboard_typing","office_ambience","none"],"uniqueKey":"agentSettings.backgroundSound","typeLabel":"enum\u003cstring>"},"globalPrompt":{"type":"string","description":"A global system prompt that is applied to every conversation to define the agent’s overall behavior, tone, and constraints.","example":"You are a professional virtual assistant. Always respond politely and keep answers concise.","uniqueKey":"agentSettings.globalPrompt","typeLabel":"string"},"remindersIntervalDuration":{"maximum":60,"minimum":10,"type":"integer","description":"Interval (in seconds) after which a follow-up reminder is automatically sent if the user does not respond.","format":"int32","example":15,"default":10,"uniqueKey":"agentSettings.remindersIntervalDuration","typeLabel":"integer\u003cint32>"},"remindersLimit":{"maximum":10,"minimum":0,"type":"integer","description":"Maximum number of follow-up reminders to send when the user does not respond. Set to 0 to disable reminders.","format":"int32","example":3,"default":4,"uniqueKey":"agentSettings.remindersLimit","typeLabel":"integer\u003cint32>"},"endCallOnSilenceDuration":{"maximum":30,"exclusiveMaximum":false,"minimum":0.1,"exclusiveMinimum":false,"type":"number","description":"Specifies the duration of continuous silence (in minutes) after which the call will be automatically ended.","format":"float","example":30,"default":5,"uniqueKey":"agentSettings.endCallOnSilenceDuration","typeLabel":"number\u003cfloat>"},"maxCallDuration":{"maximum":120,"minimum":1,"type":"integer","description":"Maximum call duration (in minutes) before the call is automatically terminated.","format":"int32","example":40,"default":60,"uniqueKey":"agentSettings.maxCallDuration","typeLabel":"integer\u003cint32>"},"llmModel":{"type":"string","description":"The language model that powers the AI's responses. To use OpenAI priority tier models, append '-fast-tier' to the model name (e.g., 'gpt-4o-mini-fast-tier').","example":"gpt-5.6-luna","default":"gpt-5.6-luna","enum":["gpt-6-sol","gpt-6-luna","gpt-5.6-sol","gpt-5.6-terra","gpt-5.6-luna","gpt-5.5","gpt-5.4","gpt-5.4-mini","gpt-5.4-nano","gpt-5.2","gpt-5.2-fast-tier","gpt-5.1","gpt-5.1-fast-tier","gpt-5","gpt-5-fast-tier","gpt-5-mini","gpt-5-mini-fast-tier","gpt-5-nano","gpt-4.1","gpt-4.1-fast-tier","gpt-4.1-mini","gpt-4.1-mini-fast-tier","gpt-4.1-nano","gpt-4.1-nano-fast-tier","gpt-4o","gpt-4o-fast-tier","gpt-4o-mini","gpt-4o-mini-fast-tier"],"uniqueKey":"agentSettings.llmModel","typeLabel":"enum\u003cstring>"},"llmTemperature":{"maximum":1,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Controls randomness in the model's output. Lower values make responses more deterministic; higher values make them more creative. If not provided, the default value is derived from the selected llmModel.","format":"double","example":0.5,"uniqueKey":"agentSettings.llmTemperature","typeLabel":"number\u003cdouble>"},"llmTopP":{"maximum":1,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Controls how diverse the output is by selecting from the most probable tokens within a probability limit. Lower values make responses more focused. If not provided, the default value is derived from the selected llmModel.","format":"double","example":0.5,"uniqueKey":"agentSettings.llmTopP","typeLabel":"number\u003cdouble>"},"llmTopK":{"maximum":200,"minimum":0,"type":"integer","description":"Limits token selection to the top-k most probable tokens. Lower values make output more deterministic; higher values increase variation. If not provided, the default value is derived from the selected llmModel","format":"int32","example":40,"uniqueKey":"agentSettings.llmTopK","typeLabel":"integer\u003cint32>"},"voiceId":{"type":"string","description":"This is the AI's speaking voice id.","example":"elevenlabs_SGbOfpm28edC83pZ9iGb","default":"elevenlabs_EXAVITQu4vr4xnSDxMaL","uniqueKey":"agentSettings.voiceId","typeLabel":"string"},"voiceModelId":{"type":"string","description":"Specifies the text-to-speech (TTS) model used by the agent to generate spoken audio responses. Different models may vary in voice quality, latency, language support, and naturalness.","example":"eleven_turbo_v2_5","default":"eleven_turbo_v2_5","enum":["eleven_multilingual_v2","eleven_flash_v2_5","eleven_turbo_v2_5","eleven_turbo_v2","eleven_flash_v2","eleven_multilingual_v1","eleven_monolingual_v1","tts-1","tts-1-hd","gpt-4o-mini-tts","sonic","sonic-2","sonic-lite","sonic-preview","sonic-turbo","arcana","mist","mistv2","octave2_multi","inworld-tts-1","inworld-tts-1-max"],"uniqueKey":"agentSettings.voiceModelId","typeLabel":"enum\u003cstring>"},"ttsSpeed":{"maximum":2,"exclusiveMaximum":false,"minimum":0.6,"exclusiveMinimum":false,"type":"number","description":"Controls the speech playback speed. Lower values make speech slower; higher values make it faster.","format":"double","example":0.7,"uniqueKey":"agentSettings.ttsSpeed","typeLabel":"number\u003cdouble>"},"ttsTemperature":{"maximum":2,"minimum":0,"type":"number","description":"Controls variation in speech delivery. Lower values make speech more consistent; higher values add more expressiveness.","format":"double","example":0.5,"uniqueKey":"agentSettings.ttsTemperature","typeLabel":"number\u003cdouble>"},"ttsVolume":{"maximum":2,"exclusiveMaximum":false,"minimum":0.5,"exclusiveMinimum":false,"type":"number","description":"Controls the output audio volume. Lower values make it quieter; higher values make it louder.","format":"double","example":0.5,"default":0,"uniqueKey":"agentSettings.ttsVolume","typeLabel":"number\u003cdouble>"},"aiStartsSpeakingPlan":{"maximum":1,"minimum":0,"type":"number","description":"How quickly AI starts speaking after user input.","format":"double","example":0.5,"default":1,"uniqueKey":"agentSettings.aiStartsSpeakingPlan","typeLabel":"number\u003cdouble>"},"aiStopsSpeakingPlan":{"maximum":1,"minimum":0,"type":"number","description":"How quickly AI stops speaking when interrupted.","format":"double","example":0.5,"default":1,"uniqueKey":"agentSettings.aiStopsSpeakingPlan","typeLabel":"number\u003cdouble>"},"ivrHangup":{"type":"boolean","description":"Determines whether the call should be automatically disconnected when an IVR system is detected during the call.","example":true,"default":false,"uniqueKey":"agentSettings.ivrHangup","typeLabel":"boolean"},"agentTimezone":{"type":"string","description":"The timezone of the agent in IANA format. Used to contextualize time-sensitive responses and scheduling.","example":"Asia/Kolkata","default":"UTC","uniqueKey":"agentSettings.agentTimezone","typeLabel":"string"},"autoVolumeNormalization":{"type":"boolean","description":"If true, it keeps the user's microphone volume consistent regardless of distance or loudness.","example":true,"default":true,"uniqueKey":"agentSettings.autoVolumeNormalization","typeLabel":"boolean"},"backgroundNoiseFilter":{"type":"boolean","description":"If true, it removes hums, buzzes, and rumbles from the audio signal.","example":true,"default":false,"uniqueKey":"agentSettings.backgroundNoiseFilter","typeLabel":"boolean"},"echoCancellation":{"type":"boolean","description":"If true, it stops the AI's audio from looping back into the microphone.","example":true,"default":true,"uniqueKey":"agentSettings.echoCancellation","typeLabel":"boolean"},"enablePostConversationAnalysis":{"type":"boolean","description":"Indicates whether post-conversation analysis should be performed to extract insights after the conversation ends.","example":true,"default":false,"uniqueKey":"agentSettings.enablePostConversationAnalysis","typeLabel":"boolean"},"postConversationAnalysisLlmModel":{"type":"string","description":"The language model that powers the AI's post-conversation analysis.","example":"gpt-5.6-luna","default":"gpt-5.6-luna","enum":["gpt-6-sol","gpt-6-luna","gpt-5.6-sol","gpt-5.6-terra","gpt-5.6-luna","gpt-5.5","gpt-5.4","gpt-5.4-mini","gpt-5.4-nano","gpt-5.2","gpt-5.2-fast-tier","gpt-5.1","gpt-5.1-fast-tier","gpt-5","gpt-5-fast-tier","gpt-5-mini","gpt-5-mini-fast-tier","gpt-5-nano","gpt-4.1","gpt-4.1-fast-tier","gpt-4.1-mini","gpt-4.1-mini-fast-tier","gpt-4.1-nano","gpt-4.1-nano-fast-tier","gpt-4o","gpt-4o-fast-tier","gpt-4o-mini","gpt-4o-mini-fast-tier"],"uniqueKey":"agentSettings.postConversationAnalysisLlmModel","typeLabel":"enum\u003cstring>"},"postConversationAnalysis":{"type":"array","description":"List of configurations defining what insights should be extracted after the conversation ends.","items":{"required":["dataType","insightInstructions","insightName"],"type":"object","properties":{"insightName":{"type":"string","description":"A Unique name of the insight that will be generated from the conversation.","example":"conversation summary","isRequired":true,"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].insightName","typeLabel":"string"},"insightInstructions":{"type":"string","description":"Instructions or prompt that define how the insight should be generated from the conversation.","isRequired":true,"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].insightInstructions","typeLabel":"string"},"dataType":{"type":"string","description":"Defines the expected data type of the generated insight result.","example":"string","enum":["string","boolean","number","selector"],"isRequired":true,"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"options":{"type":"array","description":"List of allowed selectable values. Required only when dataType is selector.","example":["Interested","Not Interested","Follow Up Later"],"items":{"type":"string","example":"[\"Interested\",\"Not Interested\",\"Follow Up Later\"]","uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].options","typeLabel":"string[]"}},"description":"List of configurations defining what insights should be extracted after the conversation ends.","uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX]","typeLabel":"object"},"uniqueKey":"agentSettings.postConversationAnalysis","typeLabel":"object[]"},"webhooks":{"type":"array","description":"List of webhook configurations that define external endpoints to be notified on specific events.","items":{"required":["events","name","url"],"type":"object","properties":{"name":{"type":"string","description":"Human-readable name for this webhook. Used to identify it in listings and dashboards. Does not need to be unique, but a descriptive name helps distinguish multiple webhooks on the same agent.","example":"Call Events - Production","isRequired":true,"uniqueKey":"agentSettings.webhooks.items.[INDEX].name","typeLabel":"string"},"url":{"pattern":"https?://.+","type":"string","description":"HTTPS endpoint that will receive event payloads as HTTP POST requests. Must be publicly reachable. The system expects an HTTP 2xx response within the configured timeout to confirm delivery. Non-2xx responses or timeouts are treated as delivery failures.","example":"https://yourapp.com/webhooks/sigmamind","isRequired":true,"uniqueKey":"agentSettings.webhooks.items.[INDEX].url","typeLabel":"string"},"events":{"uniqueItems":true,"type":"array","description":"Set of event types that will trigger a delivery to this webhook. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete. At least one event must be specified. Only events in this set will be sent — all others are silently ignored.","example":["conversation_started","conversation_ended"],"items":{"type":"string","enum":["conversation_started","conversation_ended","conversation_analysed"],"uniqueKey":"agentSettings.webhooks.items.[INDEX].events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"agentSettings.webhooks.items.[INDEX].events","typeLabel":"enum\u003cstring>[]"},"webhookId":{"type":"string","description":"A unique identifier for the webhook.","example":"wh_BUbkx3PsbzQm5V10","uniqueKey":"agentSettings.webhooks.items.[INDEX].webhookId","typeLabel":"string"}},"description":"List of webhook configurations that define external endpoints to be notified on specific events.","uniqueKey":"agentSettings.webhooks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"agentSettings.webhooks","typeLabel":"object[]"}},"description":"Request body for updating an existing AI agent, including its instructions, welcome message configuration, runtime settings, and available tools.","uniqueKey":"agentSettings","typeLabel":"object"},"nodes":{"type":"array","description":"The complete list of nodes that define the agent's conversational workflow. This list replaces the agent's existing nodes: nodes with a nodeId are updated, nodes without a nodeId are created, and any existing node omitted from the list is deleted.","items":{"oneOf":[{"type":"object","description":"Sends a response to the user before continuing to the next node in the workflow.","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["message"],"example":"message","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.0.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.0.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.0.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the message node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.0.edge","typeLabel":"object"},"parameters":{"type":"object","properties":{"instructionsType":{"type":"string","description":"Specifies how the message instructions are defined, such as static text or dynamically generated instructions.","example":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters.instructionsType","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"The instructions or message content to be delivered to the user.","example":"Hello! How can I help you today?","uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters.instructions","typeLabel":"string"},"waitTillCompletion":{"type":"boolean","description":"When true, this message plays to completion and the caller cannot interrupt it. Defaults to false.","example":false,"default":false,"uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters.waitTillCompletion","typeLabel":"boolean"}},"description":"Configuration parameters that define the message content and how its instructions are provided.","uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.0.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.0.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Runs a sub-agent with its own instructions and tools, and continues the workflow based on its configured exit conditions.","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["sub_agent"],"example":"sub_agent","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"instructions":{"type":"string","description":"Instructions that define the behavior and objective of the sub-agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.parameters.instructions","typeLabel":"string"}},"description":"Configuration parameters that define the behavior of the sub-agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.parameters","typeLabel":"object"},"edges":{"type":"array","description":"The exit conditions and destination nodes used to continue the workflow when the exit condition satisfies.","items":{"type":"object","properties":{"exitCondition":{"type":"string","description":"The condition that determines when the sub-agent should exit and continue to the next node. It can be natural language or a javascript expression.","example":"customer is asking to cancel the order.","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX].exitCondition","typeLabel":"string"},"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute after the sub-agent exits.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX].nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute after the sub-agent exits.","example":"cancel_order_sub_agent","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX].nextNodeName","typeLabel":"string"}},"description":"The exit conditions and destination nodes used to continue the workflow when the exit condition satisfies.","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.edges","typeLabel":"object[]"},"tools":{"type":"array","description":"The complete list of tools available to the sub-agent during execution. This list replaces the sub-agent's existing tools, and any existing tool omitted from the list is deleted. Pass an empty array ([]) to delete all tools. Pass null to leave the existing tools unchanged.","items":{"oneOf":[{"type":"object","description":"Transfers the active voice call to another number","required":["type","transferTo"],"properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["voice_transfer_call"],"example":"voice_transfer_call","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"transferTo":{"type":"string","description":"Destination for the call transfer. If transferToRouting is 'static', provide a valid E.164 formatted phone number. If transferToRouting is 'dynamic', provide instructions or a dynamic variable placeholder to resolve the destination at runtime. For example: If the user wants to connect with OPD, transfer to {{dynamic_variable}} or a specific number. If the user wants to connect with radiology, transfer to {{dynamic_variable}} or a specific number.","example":"+9187788XXXXX","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferTo","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","maxLength":10000,"minLength":0,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.instruction","typeLabel":"string"},"transferToRouting":{"type":"string","description":"Defines how the destination for the call transfer is determined. Use 'static' to always transfer to a fixed phone number. Use 'dynamic' to determine the destination at runtime based on conditions or extracted variables (e.g., user intent such as OPD, radiology, etc.).","example":"static","default":"static","enum":["static","dynamic"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferToRouting","typeLabel":"enum\u003cstring>"},"extensionNumber":{"pattern":"^[0-9]{1,10}$|^\\{\\{.+\\}\\}$","type":"string","description":"Optional extension number to dial after the call is transferred. This is typically used in IVR systems to reach a specific department or user.","example":"1234","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.extensionNumber","typeLabel":"string"},"transferSettings":{"required":["transferType"],"type":"object","properties":{"transferType":{"type":"string","description":"Type of transfer to perform. 'warm' keeps the current agent connected during the transfer, while 'cold' disconnects the agent immediately after initiating the transfer.","enum":["warm","cold"],"default":"warm","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.transferType","typeLabel":"enum\u003cstring>"},"ringingDuration":{"maximum":60,"minimum":25,"type":"integer","description":"Specifies the maximum duration (in seconds) to wait for the call to be answered.","format":"int32","example":40,"default":30,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.ringingDuration","typeLabel":"integer\u003cint32>"},"waitForParticipantAnswer":{"type":"boolean","description":"If true, agent will wait for the new participant to answer the call.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.waitForParticipantAnswer","typeLabel":"boolean"},"enableWhisperMessage":{"type":"boolean","description":"If true, a whisper message will be played privately to the destination participant before the caller is connected.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.enableWhisperMessage","typeLabel":"boolean"},"whisperMessage":{"type":"string","description":"The content of the whisper message. Its interpretation depends on whisperMessageType. If the type is 'static', this text is played directly. If the type is 'prompt', the text is treated as a prompt that the system uses to dynamically generate the whisper message.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.whisperMessage","typeLabel":"string"},"whisperMessageType":{"type":"string","description":"Defines how the whisperMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final whisper message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.whisperMessageType","typeLabel":"enum\u003cstring>"},"enableThreeWayMessage":{"type":"boolean","description":"If true, a message will be delivered once the call becomes a three-way conversation between the caller, the current agent, and the destination participant.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.enableThreeWayMessage","typeLabel":"boolean"},"threeWayMessage":{"type":"string","description":"The content of the message delivered during the three-way connection. Its interpretation depends on threeWayMessageType. If 'static', the message is used directly. If 'prompt', it is treated as a prompt for generating the final message.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.threeWayMessage","typeLabel":"string"},"threeWayMessageType":{"type":"string","description":"Defines how the threeWayMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.threeWayMessageType","typeLabel":"enum\u003cstring>"},"customHeaders":{"type":"object","description":"Send custom header key and values along with call transfer.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.4","typeLabel":"any[]"}],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties","typeLabel":"string | number | boolean | object | any[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders","typeLabel":"object"}},"description":"Configuration for the call transfer behaviour","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings","typeLabel":"object"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. The name may contain only alphanumeric characters and underscores (_). If not provided, a name will be generated automatically. Tool names must be unique within the same agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.toolName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Extracts and stores named variables from the conversation","required":["type","variables"],"properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["extract_variables"],"example":"extract_variables","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"variables":{"type":"array","description":"List of variables to extract from the conversation","items":{"required":["description","variableName"],"type":"object","properties":{"variableName":{"type":"string","description":"Name of the variable","example":"customer_name","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX].variableName","typeLabel":"string"},"description":{"type":"string","description":"Description of what this variable represents","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX].description","typeLabel":"string"},"dataType":{"type":"string","description":"Data type of the variable to be extracted.","example":"dateTimeIso8601","enum":["text","boolean","number","dateTimeIso8601"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"}},"description":"Defines a variable to be extracted from a conversation, including its name, data type, and description. ","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables","typeLabel":"object[]"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","maxLength":10000,"minLength":0,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.instruction","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. The name may contain only alphanumeric characters and underscores (_). If not provided, a name will be generated automatically. Tool names must be unique within the same agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.toolName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"This tool is used to navigate through IVR.","required":["type"],"properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["ivr_navigator"],"example":"ivr_navigator","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","maxLength":10000,"minLength":0,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.instruction","typeLabel":"string"},"ivrStartsConversation":{"type":"boolean","description":"Indicates whether the call is initiated by an IVR (Interactive Voice Response) system. Set to true when the interaction begins with an automated IVR prompt before connecting to an agent or system flow.","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.ivrStartsConversation","typeLabel":"boolean"},"pauseDelay":{"maximum":30000,"minimum":500,"type":"integer","description":"Specifies the duration (in milliseconds) to wait before assuming the IVR system has finished its input or prompt. This delay helps ensure that subsequent actions are triggered only after the IVR interaction is complete.","format":"int64","example":4000,"default":2000,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.pauseDelay","typeLabel":"integer\u003cint64>"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. The name may contain only alphanumeric characters and underscores (_). If not provided, a name will be generated automatically. Tool names must be unique within the same agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.toolName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"Ends the current voice call","required":["type"],"properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["voice_end_call"],"example":"voice_end_call","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","maxLength":10000,"minLength":0,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.instruction","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. The name may contain only alphanumeric characters and underscores (_). If not provided, a name will be generated automatically. Tool names must be unique within the same agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.toolName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Triggers an action from a connected app (e.g. Shopify, HubSpot)","required":["type","toolId"],"properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["integration_tool"],"example":"integration_tool","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"toolId":{"type":"string","description":"toolId of the specific integration tool to execute","example":"tool_0QqvBhLiudhHyMDC","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.toolId","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","maxLength":10000,"minLength":0,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.instruction","typeLabel":"string"},"speakWhileWaiting":{"type":"boolean","description":"If enabled, the agent will provide filler or holding speech while waiting for the tool to respond.","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.speakWhileWaiting","typeLabel":"boolean"},"placeholders":{"type":"object","additionalProperties":{"type":"string","description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.placeholders.additionalProperties","typeLabel":"string"},"description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.placeholders","typeLabel":"object"},"mapVariables":{"type":"object","additionalProperties":{"type":"string","description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.mapVariables.additionalProperties","typeLabel":"string"},"description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.mapVariables","typeLabel":"object"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. The name may contain only alphanumeric characters and underscores (_). If not provided, a name will be generated automatically. Tool names must be unique within the same agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.toolName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools","typeLabel":"object[]"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.1.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.1.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Evaluates conditions and routes the conversation to the next node based on the matching condition. Condition can be in natural language or it can be a javascript expression","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["if_else"],"example":"if_else","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.2.nodeType","typeLabel":"enum\u003cstring>"},"edges":{"type":"array","description":"The conditional branches evaluated by the node, each specifying a condition and its destination node. For the else branch, pass the condition as \"ELSE\".","items":{"type":"object","properties":{"condition":{"type":"string","description":"The condition that determines whether this branch should be selected. It can be natural language or a javascript expression.","example":"customer_type == 'premium'","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX].condition","typeLabel":"string"},"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute when the condition is satisfied.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX].nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute when the condition is satisfied.","example":"premium_customer","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX].nextNodeName","typeLabel":"string"}},"description":"The condition and destination node used to determine the next step in the workflow.","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.2.edges","typeLabel":"object[]"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.2.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.2.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"Evaluates a global condition and routes the conversation to the configured destination node when the condition is met.","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["global_condition"],"example":"global_condition","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.3.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"condition":{"type":"string","description":"The condition that determines whether this branch should be selected. It can be natural language or a javascript expression.","example":"customer_type == 'premium'","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge.condition","typeLabel":"string"},"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute when the condition is satisfied.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute when the condition is satisfied.","example":"premium_customer","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the global condition node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.3.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.3.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Transfers the active voice call to another number","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["voice_transfer_call"],"example":"voice_transfer_call","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"required":["transferTo"],"type":"object","properties":{"transferTo":{"type":"string","description":"Destination for the call transfer. If transferToRouting is 'static', provide a valid E.164 formatted phone number. If transferToRouting is 'dynamic', provide instructions or a dynamic variable placeholder to resolve the destination at runtime. For example: If the user wants to connect with OPD, transfer to {{dynamic_variable}} or a specific number. If the user wants to connect with radiology, transfer to {{dynamic_variable}} or a specific number.","example":"+9187788XXXXX","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferTo","typeLabel":"string"},"transferToRouting":{"pattern":"static|dynamic","type":"string","description":"Defines how the destination for the call transfer is determined. Use 'static' to always transfer to a fixed phone number. Use 'dynamic' to determine the destination at runtime based on conditions or extracted variables (e.g., user intent such as OPD, radiology, etc.).","example":"static","enum":["static","dynamic"],"default":"static","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferToRouting","typeLabel":"enum\u003cstring>"},"extensionNumber":{"type":"string","description":"Optional extension number to dial after the call is transferred. This is typically used in IVR systems to reach a specific department or user.","example":"1234","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.extensionNumber","typeLabel":"string"},"transferSettings":{"required":["transferType"],"type":"object","properties":{"transferType":{"type":"string","description":"Type of transfer to perform. 'warm' keeps the current agent connected during the transfer, while 'cold' disconnects the agent immediately after initiating the transfer.","enum":["warm","cold"],"default":"warm","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.transferType","typeLabel":"enum\u003cstring>"},"ringingDuration":{"maximum":60,"minimum":25,"type":"integer","description":"Specifies the maximum duration (in seconds) to wait for the call to be answered.","format":"int32","example":40,"default":30,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.ringingDuration","typeLabel":"integer\u003cint32>"},"waitForParticipantAnswer":{"type":"boolean","description":"If true, agent will wait for the new participant to answer the call.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.waitForParticipantAnswer","typeLabel":"boolean"},"enableWhisperMessage":{"type":"boolean","description":"If true, a whisper message will be played privately to the destination participant before the caller is connected.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.enableWhisperMessage","typeLabel":"boolean"},"whisperMessage":{"type":"string","description":"The content of the whisper message. Its interpretation depends on whisperMessageType. If the type is 'static', this text is played directly. If the type is 'prompt', the text is treated as a prompt that the system uses to dynamically generate the whisper message.","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.whisperMessage","typeLabel":"string"},"whisperMessageType":{"type":"string","description":"Defines how the whisperMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final whisper message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.whisperMessageType","typeLabel":"enum\u003cstring>"},"enableThreeWayMessage":{"type":"boolean","description":"If true, a message will be delivered once the call becomes a three-way conversation between the caller, the current agent, and the destination participant.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.enableThreeWayMessage","typeLabel":"boolean"},"threeWayMessage":{"type":"string","description":"The content of the message delivered during the three-way connection. Its interpretation depends on threeWayMessageType. If 'static', the message is used directly. If 'prompt', it is treated as a prompt for generating the final message.","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.threeWayMessage","typeLabel":"string"},"threeWayMessageType":{"type":"string","description":"Defines how the threeWayMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.threeWayMessageType","typeLabel":"enum\u003cstring>"},"customHeaders":{"type":"object","description":"Send custom header key and values along with call transfer.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.4","typeLabel":"any[]"}],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties","typeLabel":"string | number | boolean | object | any[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders","typeLabel":"object"}},"description":"Configuration for the call transfer behaviour","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings","typeLabel":"object"}},"description":"Configuration parameters that define the destination and behavior of the call transfer.","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters","typeLabel":"object"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.4.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.4.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the voice transfer call node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.4.edge","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.4.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.4.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"Extracts and stores named variables from the conversation","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["extract_variables"],"example":"extract_variables","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.5.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.5.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.5.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the extract variables node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.5.edge","typeLabel":"object"},"parameters":{"type":"object","properties":{"variables":{"type":"array","description":"List of variables to extract from the conversation","items":{"required":["description","variableName"],"type":"object","properties":{"variableName":{"type":"string","description":"Name of the variable","example":"customer_name","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX].variableName","typeLabel":"string"},"description":{"type":"string","description":"Description of what this variable represents","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX].description","typeLabel":"string"},"dataType":{"type":"string","description":"Data type of the variable to be extracted.","example":"dateTimeIso8601","enum":["text","boolean","number","dateTimeIso8601"],"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"}},"description":"Defines a variable to be extracted from a conversation, including its name, data type, and description. ","uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables","typeLabel":"object[]"}},"description":"Configuration parameters defining the variables to extract from the conversation.","uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.5.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.5.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","description":"This is used to navigate through IVR.","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["ivr_navigator"],"example":"ivr_navigator","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"ivrStartsConversation":{"type":"boolean","description":"Indicates whether the call is initiated by an IVR (Interactive Voice Response) system. Set to true when the interaction begins with an automated IVR prompt before connecting to an agent or system flow.","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.parameters.ivrStartsConversation","typeLabel":"boolean"},"pauseDelay":{"maximum":30000,"minimum":500,"type":"integer","description":"Specifies the duration (in milliseconds) to wait before assuming the IVR system has finished its input or prompt. This delay helps ensure that subsequent actions are triggered only after the IVR interaction is complete.","format":"int64","example":4000,"default":2000,"uniqueKey":"nodes.items.[INDEX].oneOf.6.parameters.pauseDelay","typeLabel":"integer\u003cint64>"}},"description":"Configuration parameters that control how the agent interacts with an IVR system.","uniqueKey":"nodes.items.[INDEX].oneOf.6.parameters","typeLabel":"object"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.6.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.6.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the IVR navigator node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.6.edge","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.6.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.6.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","description":"Ends the current voice call","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["voice_end_call"],"example":"voice_end_call","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.7.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.7.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.7.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the voice end call node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.7.edge","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.7.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.7.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"Triggers an action from a connected app (e.g. Shopify, HubSpot)","required":["nodeType"],"properties":{"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["integration_tool"],"example":"integration_tool","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"toolId":{"type":"string","description":"The specific tool to execute","example":"tool_0QqvBhLiudhHyMDC","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.toolId","typeLabel":"string"},"speakWhileWaiting":{"type":"boolean","description":"If enabled, the agent will provide filler or holding speech while waiting for the tool to respond","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.speakWhileWaiting","typeLabel":"boolean"},"placeholders":{"type":"object","additionalProperties":{"type":"string","description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.placeholders.additionalProperties","typeLabel":"string"},"description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.placeholders","typeLabel":"object"},"mapVariables":{"type":"object","additionalProperties":{"type":"string","description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.mapVariables.additionalProperties","typeLabel":"string"},"description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.mapVariables","typeLabel":"object"}},"description":"Configuration parameters that define the integration tool execution.","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters","typeLabel":"object"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.8.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.8.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the integration tool node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.8.edge","typeLabel":"object"},"nodeId":{"type":"string","description":"The unique identifier of an existing node within the agent. If provided, the corresponding node will be updated. If omitted, a new node will be created and added to the agent.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.8.nodeId","typeLabel":"string"},"nodeName":{"maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9_]+$","type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.8.nodeName","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8","typeLabel":"object"}],"uniqueKey":"nodes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes","typeLabel":"object[]"}},"description":"Request body for updating an existing conversational agent, including its start node, runtime settings, and workflow nodes.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agentName":"Auralis","startNodeName":"Welcome","agentSettings":{"language":"en_US","aiStartsConversation":true,"backgroundSound":"keyboard_typing","globalPrompt":"You are a professional virtual assistant. Always respond politely and keep answers concise.","remindersIntervalDuration":15,"remindersLimit":3,"endCallOnSilenceDuration":30,"maxCallDuration":40,"llmModel":"gpt-5.6-luna","llmTemperature":0.5,"llmTopP":0.5,"llmTopK":40,"voiceId":"elevenlabs_SGbOfpm28edC83pZ9iGb","voiceModelId":"eleven_turbo_v2_5","ttsSpeed":0.7,"ttsTemperature":0.5,"ttsVolume":0.5,"aiStartsSpeakingPlan":0.5,"aiStopsSpeakingPlan":0.5,"ivrHangup":true,"agentTimezone":"Asia/Kolkata","autoVolumeNormalization":true,"backgroundNoiseFilter":true,"echoCancellation":true,"enablePostConversationAnalysis":true,"postConversationAnalysisLlmModel":"gpt-5.6-luna","postConversationAnalysis":[{"insightName":"conversation summary","insightInstructions":"\u003cstring>","dataType":"string","options":["Interested","Not Interested","Follow Up Later"]}],"webhooks":[{"name":"Call Events - Production","url":"https://yourapp.com/webhooks/sigmamind","events":["conversation_started","conversation_ended"],"webhookId":"wh_BUbkx3PsbzQm5V10"}]},"nodes":[{"nodeType":"message","edge":{"nextNodeId":"node_wcCIoGrJbw9AlXVk","nextNodeName":"get_customer_detail"},"parameters":{"instructionsType":"static","instructions":"Hello! How can I help you today?","waitTillCompletion":false},"nodeId":"node_wcCIoGrJbw9AlXVk","nodeName":"get_customer_detail"}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"17173af1-5bf7-49c2-95ba-48bb5646b062":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"agentId":{"type":"string","description":"The unique identifier of the agent within the system.","example":"SPIlVscbB0kkXBvZ","uniqueKey":"agentId","typeLabel":"string"},"agentName":{"type":"string","description":"Human-readable name of the agent used to identify it in the dashboard and APIs.","example":"Auralis","uniqueKey":"agentName","typeLabel":"string"},"startNodeName":{"type":"string","description":"The name of the node where the agent workflow starts.","example":"Welcome","uniqueKey":"startNodeName","typeLabel":"string"},"startNodeId":{"type":"string","description":"The unique identifier of the node where the agent workflow starts.","example":"node_01HXYZ123","uniqueKey":"startNodeId","typeLabel":"string"},"agentSettings":{"type":"object","properties":{"language":{"type":"string","description":"The language your customers will primarily speak during calls.","example":"en_US","default":"en_US","uniqueKey":"agentSettings.language","typeLabel":"string"},"aiStartsConversation":{"type":"boolean","description":"If true the AI agent will initiate the conversation immediately when the call connects. If false the call will connect silently, waiting for the customer to speak first before the AI responds","example":true,"default":true,"uniqueKey":"agentSettings.aiStartsConversation","typeLabel":"boolean"},"backgroundSound":{"type":"string","description":"Add ambient background audio during the call.","example":"keyboard_typing","default":"none","enum":["keyboard_typing","office_ambience","none"],"uniqueKey":"agentSettings.backgroundSound","typeLabel":"enum\u003cstring>"},"globalPrompt":{"type":"string","description":"A global system prompt that is applied to every conversation to define the agent’s overall behavior, tone, and constraints.","example":"You are a professional virtual assistant. Always respond politely and keep answers concise.","uniqueKey":"agentSettings.globalPrompt","typeLabel":"string"},"remindersIntervalDuration":{"type":"integer","description":"Interval (in seconds) after which a follow-up reminder is automatically sent if the user does not respond.","format":"int32","example":15,"default":10,"uniqueKey":"agentSettings.remindersIntervalDuration","typeLabel":"integer\u003cint32>"},"remindersLimit":{"type":"integer","description":"Maximum number of follow-up reminders to send when the user does not respond.Set to 0 to disable reminders.","format":"int32","example":3,"default":4,"uniqueKey":"agentSettings.remindersLimit","typeLabel":"integer\u003cint32>"},"endCallOnSilenceDuration":{"type":"number","description":"Specifies the duration of continuous silence (in minutes) after which the call will be automatically ended.","format":"float","example":30,"default":5,"uniqueKey":"agentSettings.endCallOnSilenceDuration","typeLabel":"number\u003cfloat>"},"maxCallDuration":{"type":"integer","description":"Maximum call duration (in minutes) before the call is automatically terminated.","format":"int32","example":40,"default":60,"uniqueKey":"agentSettings.maxCallDuration","typeLabel":"integer\u003cint32>"},"llmModel":{"type":"string","description":"The language model that powers the AI's responses.","example":"gpt-4o-mini","default":"gpt-4o-mini","uniqueKey":"agentSettings.llmModel","typeLabel":"string"},"llmTemperature":{"type":"number","description":"Controls randomness in the model's output. Lower values make responses more deterministic; higher values make them more creative. If not provided, the default value is derived from the selected llmModel.","format":"double","example":0.5,"uniqueKey":"agentSettings.llmTemperature","typeLabel":"number\u003cdouble>"},"llmTopP":{"type":"number","description":"Controls how diverse the output is by selecting from the most probable tokens within a probability limit. Lower values make responses more focused. If not provided, the default value is derived from the selected llmModel.","format":"double","example":0.5,"uniqueKey":"agentSettings.llmTopP","typeLabel":"number\u003cdouble>"},"llmTopK":{"type":"integer","description":"Limits token selection to the top-k most probable tokens. Lower values make output more deterministic; higher values increase variation. If not provided, the default value is derived from the selected llmModel","format":"int32","example":40,"uniqueKey":"agentSettings.llmTopK","typeLabel":"integer\u003cint32>"},"voiceId":{"type":"string","description":"This is the AIs speaking voice id.","example":"elevenlabs_SGbOfpm28edC83pZ9iGb","default":"elevenlabs_EXAVITQu4vr4xnSDxMaL","uniqueKey":"agentSettings.voiceId","typeLabel":"string"},"voiceModelId":{"type":"string","description":"This is the AIs text to speech engine version.","example":"eleven_turbo_v2_5","default":"eleven_turbo_v2_5","uniqueKey":"agentSettings.voiceModelId","typeLabel":"string"},"ttsSpeed":{"type":"number","description":"Controls the speech playback speed. Lower values make speech slower; higher values make it faster. If not provided, the default value is derived from the selected voiceModel.","format":"double","example":0.7,"uniqueKey":"agentSettings.ttsSpeed","typeLabel":"number\u003cdouble>"},"ttsTemperature":{"type":"number","description":"Controls variation in speech delivery. Lower values make speech more consistent; higher values add more expressiveness. If not provided, the default value is derived from the selected voiceModel.","format":"double","example":0.5,"uniqueKey":"agentSettings.ttsTemperature","typeLabel":"number\u003cdouble>"},"ttsVolume":{"type":"number","description":"Controls the output audio volume. Lower values make it quieter; higher values make it louder. If not provided, the default value is derived from the selected voiceModel.","format":"double","example":0.5,"uniqueKey":"agentSettings.ttsVolume","typeLabel":"number\u003cdouble>"},"aiStartsSpeakingPlan":{"type":"number","description":"How quickly AI starts speaking after user input.","format":"double","example":0.5,"default":1,"uniqueKey":"agentSettings.aiStartsSpeakingPlan","typeLabel":"number\u003cdouble>"},"aiStopsSpeakingPlan":{"type":"number","description":"How quickly AI stops speaking when interrupted.","format":"double","example":0.5,"default":1,"uniqueKey":"agentSettings.aiStopsSpeakingPlan","typeLabel":"number\u003cdouble>"},"ivrHangup":{"type":"boolean","description":"Determines whether the call should be automatically disconnected when an IVR system is detected during the call.","example":true,"default":false,"uniqueKey":"agentSettings.ivrHangup","typeLabel":"boolean"},"agentTimezone":{"type":"string","description":"The timezone of the agent in IANA format. Used to contextualize time-sensitive responses and scheduling.","example":"Asia/Kolkata","default":"UTC","uniqueKey":"agentSettings.agentTimezone","typeLabel":"string"},"autoVolumeNormalization":{"type":"boolean","description":"If true, it keeps the user's microphone volume consistent regardless of distance or loudness.","example":true,"default":true,"uniqueKey":"agentSettings.autoVolumeNormalization","typeLabel":"boolean"},"backgroundNoiseFilter":{"type":"boolean","description":"If true, it removes hums, buzzes, and rumbles from the audio signal.","example":true,"default":false,"uniqueKey":"agentSettings.backgroundNoiseFilter","typeLabel":"boolean"},"echoCancellation":{"type":"boolean","description":"If true, it stops the AI's audio from looping back into the microphone.","example":true,"default":true,"uniqueKey":"agentSettings.echoCancellation","typeLabel":"boolean"},"enablePostConversationAnalysis":{"type":"boolean","description":"Indicates whether post-conversation analysis should be performed to extract insights after the conversation ends.","example":true,"default":false,"uniqueKey":"agentSettings.enablePostConversationAnalysis","typeLabel":"boolean"},"postConversationAnalysisLlmModel":{"type":"string","description":"The language model that powers the AI's post-conversation analysis.","example":"gpt-4o-mini","default":"gpt-4o-mini","uniqueKey":"agentSettings.postConversationAnalysisLlmModel","typeLabel":"string"},"postConversationAnalysis":{"type":"array","description":"List of configurations defining what insights should be extracted after the conversation ends.","items":{"required":["dataType","insightInstructions","insightName"],"type":"object","properties":{"insightName":{"type":"string","description":"A Unique name of the insight that will be generated from the conversation.","example":"conversation summary","isRequired":true,"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].insightName","typeLabel":"string"},"insightInstructions":{"type":"string","description":"Instructions or prompt that define how the insight should be generated from the conversation.","isRequired":true,"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].insightInstructions","typeLabel":"string"},"dataType":{"type":"string","description":"Defines the expected data type of the generated insight result.","example":"string","enum":["string","boolean","number","selector"],"isRequired":true,"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"options":{"type":"array","description":"List of allowed selectable values. Required only when dataType is selector.","example":["Interested","Not Interested","Follow Up Later"],"items":{"type":"string","example":"[\"Interested\",\"Not Interested\",\"Follow Up Later\"]","uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX].options","typeLabel":"string[]"}},"description":"List of configurations defining what insights should be extracted after the conversation ends.","uniqueKey":"agentSettings.postConversationAnalysis.items.[INDEX]","typeLabel":"object"},"uniqueKey":"agentSettings.postConversationAnalysis","typeLabel":"object[]"},"webhooks":{"type":"array","description":"List of webhook configurations that define external endpoints to be notified on specific events.","items":{"type":"object","properties":{"webhookId":{"type":"string","description":"A unique identifier for the webhook.","example":"wh_BUbkx3PsbzQm5V10","uniqueKey":"agentSettings.webhooks.items.[INDEX].webhookId","typeLabel":"string"},"name":{"type":"string","description":"Human-readable name for this webhook. Used to identify it in listings and dashboards. Does not need to be unique, but a descriptive name helps distinguish multiple webhooks on the same agent.","example":"My Webhook","uniqueKey":"agentSettings.webhooks.items.[INDEX].name","typeLabel":"string"},"url":{"pattern":"https?://.+","type":"string","description":"HTTPS endpoint that will receive event payloads as HTTP POST requests. Must be publicly reachable. The system expects an HTTP 2xx response within the configured timeout to confirm delivery. Non-2xx responses or timeouts are treated as delivery failures.","example":"https://example.com/webhook","uniqueKey":"agentSettings.webhooks.items.[INDEX].url","typeLabel":"string"},"secret":{"type":"string","description":"Secret key used to authenticate webhook payloads. This key should be securely stored and verified on the receiving server.","example":"mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u","uniqueKey":"agentSettings.webhooks.items.[INDEX].secret","typeLabel":"string"},"events":{"type":"array","description":"Set of event types that will trigger a delivery to this webhook. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete. At least one event must be specified. Only events in this set will be sent — all others are silently ignored.","items":{"type":"string","description":"List of webhook configurations that define external endpoints to be notified on specific events.","uniqueKey":"agentSettings.webhooks.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"agentSettings.webhooks.items.[INDEX].events","typeLabel":"string[]"}},"uniqueKey":"agentSettings.webhooks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"agentSettings.webhooks","typeLabel":"object[]"}},"description":"Configuration settings that define the agent’s runtime behavior, including voice, llm model and other operational settings.","uniqueKey":"agentSettings","typeLabel":"object"},"nodes":{"type":"array","items":{"oneOf":[{"type":"object","description":"Sends a response to the user before continuing to the next node in the workflow.","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.0.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.0.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["message"],"example":"message","uniqueKey":"nodes.items.[INDEX].oneOf.0.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.0.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.0.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the message node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.0.edge","typeLabel":"object"},"parameters":{"type":"object","properties":{"instructionsType":{"type":"string","description":"Specifies how the message instructions are defined, such as static text or dynamically generated instructions.","example":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters.instructionsType","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"The instructions or message content to be delivered to the user.","example":"Hello! How can I help you today?","uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters.instructions","typeLabel":"string"},"waitTillCompletion":{"type":"boolean","description":"When true, this message plays to completion and the caller cannot interrupt it. Defaults to false.","example":false,"default":false,"uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters.waitTillCompletion","typeLabel":"boolean"}},"description":"Configuration parameters that define the message content and how its instructions are provided.","uniqueKey":"nodes.items.[INDEX].oneOf.0.parameters","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Runs a sub-agent with its own instructions and tools, and continues the workflow based on its configured exit conditions.","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.1.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.1.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["sub_agent"],"example":"sub_agent","uniqueKey":"nodes.items.[INDEX].oneOf.1.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"instructions":{"type":"string","description":"Instructions that define the behavior and objective of the sub-agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.parameters.instructions","typeLabel":"string"}},"description":"Configuration parameters that define the behavior of the sub-agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.parameters","typeLabel":"object"},"edges":{"type":"array","description":"The exit conditions and destination nodes used to continue the workflow when the exit condition satisfies.","items":{"type":"object","properties":{"exitCondition":{"type":"string","description":"The condition that determines when the sub-agent should exit and continue to the next node. It can be natural language or a javascript expression.","example":"customer is asking to cancel the order.","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX].exitCondition","typeLabel":"string"},"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute after the sub-agent exits.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX].nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute after the sub-agent exits.","example":"cancel_order_sub_agent","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX].nextNodeName","typeLabel":"string"}},"description":"The exit conditions and destination nodes used to continue the workflow when the exit condition satisfies.","uniqueKey":"nodes.items.[INDEX].oneOf.1.edges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.edges","typeLabel":"object[]"},"tools":{"type":"array","description":"Tools available to the sub-agent during execution.","items":{"oneOf":[{"type":"object","description":"Transfers the active voice call to another number","properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["voice_transfer_call"],"example":"voice_transfer_call","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"nodeId":{"type":"string","description":"The unique identifier of the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.nodeId","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. Use this name to reference the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.toolName","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.instruction","typeLabel":"string"},"transferToRouting":{"type":"string","description":"Defines how the destination for the call transfer is determined. Use 'static' to always transfer to a fixed phone number. Use 'dynamic' to determine the destination at runtime based on conditions or extracted variables (e.g., user intent such as OPD, radiology, etc.).","example":"static","default":"static","enum":["static","dynamic"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferToRouting","typeLabel":"enum\u003cstring>"},"transferTo":{"type":"string","description":"Destination for the call transfer. If transferToRouting is 'static', provide a valid E.164 formatted phone number. If transferToRouting is 'dynamic', provide instructions or a dynamic variable placeholder to resolve the destination at runtime. For example: If the user wants to connect with OPD, transfer to {{dynamic_variable}} or a specific number. If the user wants to connect with radiology, transfer to {{dynamic_variable}} or a specific number.","example":"+9187788XXXXX","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferTo","typeLabel":"string"},"extensionNumber":{"type":"string","description":"Optional extension number to dial after the call is transferred. This is typically used in IVR systems to reach a specific department or user.","example":"1234","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.extensionNumber","typeLabel":"string"},"transferSettings":{"required":["transferType"],"type":"object","properties":{"transferType":{"type":"string","description":"Type of transfer to perform. 'warm' keeps the current agent connected during the transfer, while 'cold' disconnects the agent immediately after initiating the transfer.","enum":["warm","cold"],"default":"warm","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.transferType","typeLabel":"enum\u003cstring>"},"ringingDuration":{"maximum":60,"minimum":25,"type":"integer","description":"Specifies the maximum duration (in seconds) to wait for the call to be answered.","format":"int32","example":40,"default":30,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.ringingDuration","typeLabel":"integer\u003cint32>"},"waitForParticipantAnswer":{"type":"boolean","description":"If true, agent will wait for the new participant to answer the call.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.waitForParticipantAnswer","typeLabel":"boolean"},"enableWhisperMessage":{"type":"boolean","description":"If true, a whisper message will be played privately to the destination participant before the caller is connected.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.enableWhisperMessage","typeLabel":"boolean"},"whisperMessage":{"type":"string","description":"The content of the whisper message. Its interpretation depends on whisperMessageType. If the type is 'static', this text is played directly. If the type is 'prompt', the text is treated as a prompt that the system uses to dynamically generate the whisper message.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.whisperMessage","typeLabel":"string"},"whisperMessageType":{"type":"string","description":"Defines how the whisperMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final whisper message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.whisperMessageType","typeLabel":"enum\u003cstring>"},"enableThreeWayMessage":{"type":"boolean","description":"If true, a message will be delivered once the call becomes a three-way conversation between the caller, the current agent, and the destination participant.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.enableThreeWayMessage","typeLabel":"boolean"},"threeWayMessage":{"type":"string","description":"The content of the message delivered during the three-way connection. Its interpretation depends on threeWayMessageType. If 'static', the message is used directly. If 'prompt', it is treated as a prompt for generating the final message.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.threeWayMessage","typeLabel":"string"},"threeWayMessageType":{"type":"string","description":"Defines how the threeWayMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.threeWayMessageType","typeLabel":"enum\u003cstring>"},"customHeaders":{"type":"object","description":"Send custom header key and values along with call transfer.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties.oneOf.4","typeLabel":"any[]"}],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders.additionalProperties","typeLabel":"string | number | boolean | object | any[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings.customHeaders","typeLabel":"object"}},"description":"Configuration for the call transfer behaviour","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0.transferSettings","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Extracts and stores named variables from the conversation","properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["extract_variables"],"example":"extract_variables","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"nodeId":{"type":"string","description":"The unique identifier of the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.nodeId","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. Use this name to reference the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.toolName","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.instruction","typeLabel":"string"},"variables":{"type":"array","description":"List of variables to extract from the conversation","items":{"required":["description","variableName"],"type":"object","properties":{"variableName":{"type":"string","description":"Name of the variable","example":"customer_name","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX].variableName","typeLabel":"string"},"description":{"type":"string","description":"Description of what this variable represents","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX].description","typeLabel":"string"},"dataType":{"type":"string","description":"Data type of the variable to be extracted.","example":"dateTimeIso8601","enum":["text","boolean","number","dateTimeIso8601"],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"}},"description":"Defines a variable to be extracted from a conversation, including its name, data type, and description. ","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1.variables","typeLabel":"object[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"This tool is used to navigate through IVR.","properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["ivr_navigator"],"example":"ivr_navigator","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"nodeId":{"type":"string","description":"The unique identifier of the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.nodeId","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. Use this name to reference the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.toolName","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.instruction","typeLabel":"string"},"ivrStartsConversation":{"type":"boolean","description":"Indicates whether the call is initiated by an IVR (Interactive Voice Response) system. Set to true when the interaction begins with an automated IVR prompt before connecting to an agent or system flow.","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.ivrStartsConversation","typeLabel":"boolean"},"pauseDelay":{"maximum":30000,"minimum":500,"type":"integer","description":"Specifies the duration (in milliseconds) to wait before assuming the IVR system has finished its input or prompt. This delay helps ensure that subsequent actions are triggered only after the IVR interaction is complete.","format":"int64","example":4000,"default":2000,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2.pauseDelay","typeLabel":"integer\u003cint64>"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"Ends the current voice call","properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["voice_end_call"],"example":"voice_end_call","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"nodeId":{"type":"string","description":"The unique identifier of the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.nodeId","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. Use this name to reference the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.toolName","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3.instruction","typeLabel":"string"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Triggers an action from a connected app (e.g. Shopify, HubSpot)","properties":{"type":{"type":"string","description":"The type determines the tool’s behavior and configuration schema, such as call transfer, variable extraction, IVR navigation, integrations, etc.","enum":["integration_tool"],"example":"integration_tool","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"nodeId":{"type":"string","description":"The unique identifier of the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.nodeId","typeLabel":"string"},"toolName":{"type":"string","description":"A unique name used to identify the tool within an agent. Use this name to reference the tool within the agent.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.toolName","typeLabel":"string"},"instruction":{"type":"string","description":"Instructions that define when the agent should invoke this tool during a conversation. Use this field to describe the scenarios, user intents, or conditions under which the tool should be triggered.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.instruction","typeLabel":"string"},"toolId":{"type":"string","description":"The specific tool to execute","example":"tool_0QqvBhLiudhHyMDC","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.toolId","typeLabel":"string"},"speakWhileWaiting":{"type":"boolean","description":"If enabled, the agent will provide filler or holding speech while waiting for the tool to respond","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.speakWhileWaiting","typeLabel":"boolean"},"placeholders":{"type":"object","additionalProperties":{"type":"string","description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.placeholders.additionalProperties","typeLabel":"string"},"description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.placeholders","typeLabel":"object"},"mapVariables":{"type":"object","additionalProperties":{"type":"string","description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.mapVariables.additionalProperties","typeLabel":"string"},"description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path","uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4.mapVariables","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.1.tools","typeLabel":"object[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Evaluates conditions and routes the conversation to the next node based on the matching condition. Condition can be in natural language or it can be a javascript expression","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.2.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.2.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["if_else"],"example":"if_else","uniqueKey":"nodes.items.[INDEX].oneOf.2.nodeType","typeLabel":"enum\u003cstring>"},"edges":{"type":"array","description":"The conditional branches evaluated by the node, each specifying a condition and its destination node. For the else branch, pass the condition as \"ELSE\".","items":{"type":"object","properties":{"condition":{"type":"string","description":"The condition that determines whether this branch should be selected. It can be natural language or a javascript expression.","example":"customer_type == 'premium'","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX].condition","typeLabel":"string"},"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute when the condition is satisfied.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX].nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute when the condition is satisfied.","example":"premium_customer","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX].nextNodeName","typeLabel":"string"}},"description":"The condition and destination node used to determine the next step in the workflow.","uniqueKey":"nodes.items.[INDEX].oneOf.2.edges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.2.edges","typeLabel":"object[]"}},"uniqueKey":"nodes.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"Evaluates a global condition and routes the conversation to the configured destination node when the condition is met.","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.3.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.3.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["global_condition"],"example":"global_condition","uniqueKey":"nodes.items.[INDEX].oneOf.3.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"condition":{"type":"string","description":"The condition that determines whether this branch should be selected. It can be natural language or a javascript expression.","example":"customer_type == 'premium'","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge.condition","typeLabel":"string"},"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute when the condition is satisfied.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute when the condition is satisfied.","example":"premium_customer","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the global condition node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.3.edge","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Transfers the active voice call to another number","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.4.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.4.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["voice_transfer_call"],"example":"voice_transfer_call","uniqueKey":"nodes.items.[INDEX].oneOf.4.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"required":["transferTo"],"type":"object","properties":{"transferTo":{"type":"string","description":"Destination for the call transfer. If transferToRouting is 'static', provide a valid E.164 formatted phone number. If transferToRouting is 'dynamic', provide instructions or a dynamic variable placeholder to resolve the destination at runtime. For example: If the user wants to connect with OPD, transfer to {{dynamic_variable}} or a specific number. If the user wants to connect with radiology, transfer to {{dynamic_variable}} or a specific number.","example":"+9187788XXXXX","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferTo","typeLabel":"string"},"transferToRouting":{"pattern":"static|dynamic","type":"string","description":"Defines how the destination for the call transfer is determined. Use 'static' to always transfer to a fixed phone number. Use 'dynamic' to determine the destination at runtime based on conditions or extracted variables (e.g., user intent such as OPD, radiology, etc.).","example":"static","enum":["static","dynamic"],"default":"static","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferToRouting","typeLabel":"enum\u003cstring>"},"extensionNumber":{"type":"string","description":"Optional extension number to dial after the call is transferred. This is typically used in IVR systems to reach a specific department or user.","example":"1234","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.extensionNumber","typeLabel":"string"},"transferSettings":{"required":["transferType"],"type":"object","properties":{"transferType":{"type":"string","description":"Type of transfer to perform. 'warm' keeps the current agent connected during the transfer, while 'cold' disconnects the agent immediately after initiating the transfer.","enum":["warm","cold"],"default":"warm","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.transferType","typeLabel":"enum\u003cstring>"},"ringingDuration":{"maximum":60,"minimum":25,"type":"integer","description":"Specifies the maximum duration (in seconds) to wait for the call to be answered.","format":"int32","example":40,"default":30,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.ringingDuration","typeLabel":"integer\u003cint32>"},"waitForParticipantAnswer":{"type":"boolean","description":"If true, agent will wait for the new participant to answer the call.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.waitForParticipantAnswer","typeLabel":"boolean"},"enableWhisperMessage":{"type":"boolean","description":"If true, a whisper message will be played privately to the destination participant before the caller is connected.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.enableWhisperMessage","typeLabel":"boolean"},"whisperMessage":{"type":"string","description":"The content of the whisper message. Its interpretation depends on whisperMessageType. If the type is 'static', this text is played directly. If the type is 'prompt', the text is treated as a prompt that the system uses to dynamically generate the whisper message.","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.whisperMessage","typeLabel":"string"},"whisperMessageType":{"type":"string","description":"Defines how the whisperMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final whisper message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.whisperMessageType","typeLabel":"enum\u003cstring>"},"enableThreeWayMessage":{"type":"boolean","description":"If true, a message will be delivered once the call becomes a three-way conversation between the caller, the current agent, and the destination participant.","default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.enableThreeWayMessage","typeLabel":"boolean"},"threeWayMessage":{"type":"string","description":"The content of the message delivered during the three-way connection. Its interpretation depends on threeWayMessageType. If 'static', the message is used directly. If 'prompt', it is treated as a prompt for generating the final message.","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.threeWayMessage","typeLabel":"string"},"threeWayMessageType":{"type":"string","description":"Defines how the threeWayMessage should be interpreted. 'static' means the message is used as-is, while 'prompt' means the message is treated as a prompt for generating the final message.","default":"static","enum":["static","prompt"],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.threeWayMessageType","typeLabel":"enum\u003cstring>"},"customHeaders":{"type":"object","description":"Send custom header key and values along with call transfer.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"object","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties.oneOf.4","typeLabel":"any[]"}],"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders.additionalProperties","typeLabel":"string | number | boolean | object | any[]"},"uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings.customHeaders","typeLabel":"object"}},"description":"Configuration for the call transfer behaviour","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters.transferSettings","typeLabel":"object"}},"description":"Configuration parameters that define the destination and behavior of the call transfer.","uniqueKey":"nodes.items.[INDEX].oneOf.4.parameters","typeLabel":"object"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.4.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.4.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the voice transfer call node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.4.edge","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"Extracts and stores named variables from the conversation","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.5.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.5.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["extract_variables"],"example":"extract_variables","uniqueKey":"nodes.items.[INDEX].oneOf.5.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.5.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.5.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the extract variables node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.5.edge","typeLabel":"object"},"parameters":{"type":"object","properties":{"variables":{"type":"array","description":"List of variables to extract from the conversation","items":{"required":["description","variableName"],"type":"object","properties":{"variableName":{"type":"string","description":"Name of the variable","example":"customer_name","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX].variableName","typeLabel":"string"},"description":{"type":"string","description":"Description of what this variable represents","isRequired":true,"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX].description","typeLabel":"string"},"dataType":{"type":"string","description":"Data type of the variable to be extracted.","example":"dateTimeIso8601","enum":["text","boolean","number","dateTimeIso8601"],"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"}},"description":"Defines a variable to be extracted from a conversation, including its name, data type, and description. ","uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters.variables","typeLabel":"object[]"}},"description":"Configuration parameters defining the variables to extract from the conversation.","uniqueKey":"nodes.items.[INDEX].oneOf.5.parameters","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","description":"This is used to navigate through IVR.","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.6.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.6.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["ivr_navigator"],"example":"ivr_navigator","uniqueKey":"nodes.items.[INDEX].oneOf.6.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"ivrStartsConversation":{"type":"boolean","description":"Indicates whether the call is initiated by an IVR (Interactive Voice Response) system. Set to true when the interaction begins with an automated IVR prompt before connecting to an agent or system flow.","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.6.parameters.ivrStartsConversation","typeLabel":"boolean"},"pauseDelay":{"maximum":30000,"minimum":500,"type":"integer","description":"Specifies the duration (in milliseconds) to wait before assuming the IVR system has finished its input or prompt. This delay helps ensure that subsequent actions are triggered only after the IVR interaction is complete.","format":"int64","example":4000,"default":2000,"uniqueKey":"nodes.items.[INDEX].oneOf.6.parameters.pauseDelay","typeLabel":"integer\u003cint64>"}},"description":"Configuration parameters that control how the agent interacts with an IVR system.","uniqueKey":"nodes.items.[INDEX].oneOf.6.parameters","typeLabel":"object"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.6.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.6.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the IVR navigator node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.6.edge","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","description":"Ends the current voice call","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.7.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.7.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["voice_end_call"],"example":"voice_end_call","uniqueKey":"nodes.items.[INDEX].oneOf.7.nodeType","typeLabel":"enum\u003cstring>"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.7.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.7.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the voice end call node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.7.edge","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"Triggers an action from a connected app (e.g. Shopify, HubSpot)","properties":{"nodeId":{"type":"string","description":"Unique identifier of the node.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.8.nodeId","typeLabel":"string"},"nodeName":{"type":"string","description":"Human-readable name of the node. Must be unique within the agent and contain only letters, numbers, and underscores.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.8.nodeName","typeLabel":"string"},"nodeType":{"type":"string","description":"Type of the node, which determines its behavior and available configuration.","enum":["integration_tool"],"example":"integration_tool","uniqueKey":"nodes.items.[INDEX].oneOf.8.nodeType","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"toolId":{"type":"string","description":"The specific tool to execute","example":"tool_0QqvBhLiudhHyMDC","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.toolId","typeLabel":"string"},"speakWhileWaiting":{"type":"boolean","description":"If enabled, the agent will provide filler or holding speech while waiting for the tool to respond","example":true,"default":true,"uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.speakWhileWaiting","typeLabel":"boolean"},"placeholders":{"type":"object","additionalProperties":{"type":"string","description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.placeholders.additionalProperties","typeLabel":"string"},"description":"Defines values for the placeholders expected by the integration tool. Each key represents a placeholder name and its value can either be a static value or a dynamic variable using the format {{variable_name}} to inject runtime data.","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.placeholders","typeLabel":"object"},"mapVariables":{"type":"object","additionalProperties":{"type":"string","description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.mapVariables.additionalProperties","typeLabel":"string"},"description":"Maps the response paths of the tool to dynamic variables. Each key is the variable name and the value is the mapped response path","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters.mapVariables","typeLabel":"object"}},"description":"Configuration parameters that define the integration tool execution.","uniqueKey":"nodes.items.[INDEX].oneOf.8.parameters","typeLabel":"object"},"edge":{"type":"object","properties":{"nextNodeId":{"type":"string","description":"The unique identifier of the node to execute next.","example":"node_wcCIoGrJbw9AlXVk","uniqueKey":"nodes.items.[INDEX].oneOf.8.edge.nextNodeId","typeLabel":"string"},"nextNodeName":{"type":"string","description":"The name of the node to execute next.","example":"get_customer_detail","uniqueKey":"nodes.items.[INDEX].oneOf.8.edge.nextNodeName","typeLabel":"string"}},"description":"The next node to execute after the integration tool node completes.","uniqueKey":"nodes.items.[INDEX].oneOf.8.edge","typeLabel":"object"}},"uniqueKey":"nodes.items.[INDEX].oneOf.8","typeLabel":"object"}],"uniqueKey":"nodes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nodes","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agentId":"SPIlVscbB0kkXBvZ","agentName":"Auralis","startNodeName":"Welcome","startNodeId":"node_01HXYZ123","agentSettings":{"language":"en_US","aiStartsConversation":true,"backgroundSound":"keyboard_typing","globalPrompt":"You are a professional virtual assistant. Always respond politely and keep answers concise.","remindersIntervalDuration":15,"remindersLimit":3,"endCallOnSilenceDuration":30,"maxCallDuration":40,"llmModel":"gpt-4o-mini","llmTemperature":0.5,"llmTopP":0.5,"llmTopK":40,"voiceId":"elevenlabs_SGbOfpm28edC83pZ9iGb","voiceModelId":"eleven_turbo_v2_5","ttsSpeed":0.7,"ttsTemperature":0.5,"ttsVolume":0.5,"aiStartsSpeakingPlan":0.5,"aiStopsSpeakingPlan":0.5,"ivrHangup":true,"agentTimezone":"Asia/Kolkata","autoVolumeNormalization":true,"backgroundNoiseFilter":true,"echoCancellation":true,"enablePostConversationAnalysis":true,"postConversationAnalysisLlmModel":"gpt-4o-mini","postConversationAnalysis":[{"insightName":"conversation summary","insightInstructions":"\u003cstring>","dataType":"string","options":["Interested","Not Interested","Follow Up Later"]}],"webhooks":[{"webhookId":"wh_BUbkx3PsbzQm5V10","name":"My Webhook","url":"https://example.com/webhook","secret":"mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u","events":["\u003cstring>"]}]},"nodes":[{"nodeId":"node_wcCIoGrJbw9AlXVk","nodeName":"get_customer_detail","nodeType":"message","edge":{"nextNodeId":"node_wcCIoGrJbw9AlXVk","nextNodeName":"get_customer_detail"},"parameters":{"instructionsType":"static","instructions":"Hello! How can I help you today?","waitTillCompletion":false}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6b0f2446-5e26-42b6-b42c-7b642d8431a6":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Bad Request","message":"Invalid request parameters","path":"/v1/conversational-agents","status":400,"timestamp":"2026-09-28T16:34:43.684Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"6bffb623-11f4-401b-8902-7cc0616a8a96":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Unauthorized","message":"X-API-Key is missing or invalid","path":"/v1/conversational-agents","status":401,"timestamp":"2026-09-28T16:34:43.684Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"52caceee-3ece-4f57-a58d-19f0297acefb":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Forbidden","message":"Access denied for this resource","path":"/v1/conversational-agents","status":403,"timestamp":"2026-09-28T16:34:43.684Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"090fb6df-3aeb-4787-8b72-02719e0c6595":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Not Found","message":"The requested resource was not found","path":"/v1/conversational-agents","status":404,"timestamp":"2026-09-28T16:34:43.684Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"e3a9cccb-7650-4a23-866e-23ba0a9c8257":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Internal Server Error","message":"Unexpected server error","path":"/v1/conversational-agents","status":500,"timestamp":"2026-09-28T16:34:43.684Z"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"942fdac5-677d-45bf-9a32-66b9441b7597":{"apiKeyAuth":{"type":"apiKey","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"8e559e02-781a-40b4-9c1f-0150c00e3590":{"url":"https://api.sigmamind.ai","description":"SigmaMind AI Agent Builder APIs"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-Key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-docs.yaml"},"subdomain":"sigmamindai","siteName":"SigmaMind AI","title":"Update conversational Agent - SigmaMind AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-06T14:53:39.033Z","originalFileLocation":"api-reference/conversational-agents/update-conversational-agent.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SigmaMind AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update conversational Agent - SigmaMind AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SigmaMind AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sigmamindai.mintlify.site/_mintlify/api/og/v2?division=Conversational+Agents\u0026amp;title=Update+conversational+Agent\u0026amp;description=Partially+updates+an+existing+conversational+agent+by+agentId.+Only+the+fields+provided+in+the+request+body+are+updated+%E2%80%94+omitted+fields+remain+unchanged.+Nodes\u0026amp;theme=fef818be99f9332d6af1a382\u0026amp;signature=1f10b462d950b7e8590e18739feb6f9c1f3a142be081190e17ce16183bdab6db\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update conversational Agent - SigmaMind AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sigmamindai.mintlify.site/_mintlify/api/og/v2?division=Conversational+Agents\u0026amp;title=Update+conversational+Agent\u0026amp;description=Partially+updates+an+existing+conversational+agent+by+agentId.+Only+the+fields+provided+in+the+request+body+are+updated+%E2%80%94+omitted+fields+remain+unchanged.+Nodes\u0026amp;theme=fef818be99f9332d6af1a382\u0026amp;signature=1f10b462d950b7e8590e18739feb6f9c1f3a142be081190e17ce16183bdab6db\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SigmaMind AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F172A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/conversational-agents/update-conversational-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sigmamind.ai/#organization\",\"name\":\"SigmaMind AI\",\"url\":\"https://docs.sigmamind.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/light.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=bc51a1190d0d56521defbdc28b2a0798\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sigmamind.ai#website\",\"name\":\"SigmaMind AI\",\"url\":\"https://docs.sigmamind.ai\",\"publisher\":{\"@id\":\"https://docs.sigmamind.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent#webpage\",\"url\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent\",\"name\":\"Update conversational Agent\",\"description\":\"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.\",\"dateModified\":\"2026-10-06T14:53:39.033Z\",\"isPartOf\":{\"@id\":\"https://docs.sigmamind.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Conversational Agents\",\"item\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/create-conversational-agent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update conversational Agent\",\"item\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent#apireference\",\"headline\":\"Update conversational Agent\",\"name\":\"Update conversational Agent\",\"description\":\"Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their edges. Returns the updated agent including all of its nodes and agent settings.\",\"url\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent#webpage\"},\"dateModified\":\"2026-10-06T14:53:39.033Z\",\"publisher\":{\"@id\":\"https://docs.sigmamind.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sigmamind.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SigmaMind AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"SigmaMind AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/conversational-agents/update-conversational-agent.md","siteName":"SigmaMind AI","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.sigmamind.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://www.discord.com/invite/jSWGcw5Wyx"}]},"tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/documentation/getting-started/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Calls","pages":[{"openapi":"post /v1/calls","title":"Create Phone Call","href":"/api-reference/calls/create-phone-call"},{"openapi":"get /v1/calls/{callId}","title":"Get Phone Call","href":"/api-reference/calls/get-phone-call"},{"openapi":"get /v1/calls","title":"List Phone Calls","href":"/api-reference/calls/list-phone-calls"},{"openapi":"delete /v1/calls/{callId}","title":"Delete Phone Call","href":"/api-reference/calls/delete-phone-call"}]},{"group":"Chats","pages":[{"openapi":"post /v1/chats","title":"Create Chat","href":"/api-reference/chats/create-a-chat"},{"openapi":"post /v1/chats/response","title":"Chat Completion","href":"/api-reference/chats/chat-completion"},{"openapi":"get /v1/chats/{chatId}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /v1/chats","title":"List Chats","href":"/api-reference/chats/list-chats"},{"openapi":"patch /v1/chats/{chatId}","title":"Update Chat","href":"/api-reference/chats/update-chat"},{"openapi":"patch /v1/chats/{chatId}/end-session","title":"End Chat","href":"/api-reference/chats/end-chat"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /v1/phone-numbers","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"post /v1/phone-numbers/import","title":"Import Phone Number","href":"/api-reference/phone-numbers/import-phone-number"},{"openapi":"get /v1/phone-numbers/{phoneNumber}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /v1/phone-numbers","title":"List Phone Numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /v1/phone-numbers/{phoneNumber}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"},{"openapi":"delete /v1/phone-numbers/{phoneNumber}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"}]},{"group":"Single Prompt Agents","pages":[{"openapi":"post /v1/agents","title":"Create Agent","href":"/api-reference/single-prompt-agents/create-agent"},{"openapi":"get /v1/agents/{agentId}","title":"Get Agent","href":"/api-reference/single-prompt-agents/get-agent"},{"openapi":"get /v1/agents","title":"List Agents","href":"/api-reference/single-prompt-agents/list-single-prompt-agents"},{"openapi":"patch /v1/agents/{agentId}","title":"Update Agent","href":"/api-reference/single-prompt-agents/update-agent"},{"openapi":"delete /v1/agents/{agentId}","title":"Delete Agent","href":"/api-reference/single-prompt-agents/delete-agent"}]},{"group":"Conversational Agents","pages":[{"openapi":"post /v1/conversational-agents","title":"Create conversational Agent","href":"/api-reference/conversational-agents/create-conversational-agent"},{"openapi":"get /v1/conversational-agents/{agentId}","title":"Get conversational Agent","description":"Get a conversational agent, along with agent settings","href":"/api-reference/conversational-agents/get-conversational-agent"},{"openapi":"patch /v1/conversational-agents/{agentId}","title":"Update conversational Agent","href":"/api-reference/conversational-agents/update-conversational-agent"}]},{"group":"Campaigns","pages":[{"openapi":"post /v1/campaigns","title":"Create Campaign","description":"Creates an outbound call campaign with the specified agent, caller number, and CSV contact list. Set isScheduled=true with scheduledDate, scheduledTime, and scheduledTimezone to defer launch. Returns the created campaign, including its campaignId.","href":"/api-reference/campaigns/create-campaign"},{"openapi":"get /v1/campaigns/{campaignId}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /v1/campaigns","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /v1/campaigns/{campaignId}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"},{"openapi":"delete /v1/campaigns/{campaignId}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"}]},{"group":"Integrations","pages":[{"openapi":"post /v1/integrations","title":"Create Integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/{integrationId}","title":"Get Integration","href":"/api-reference/integrations/get-integration"},{"openapi":"get /v1/integrations","title":"List Integrations","href":"/api-reference/integrations/list-integrations"},{"openapi":"patch /v1/integrations/{integrationId}","title":"Update Integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete Integration","href":"/api-reference/integrations/delete-integration"}]},{"group":"Integration Auth","pages":[{"openapi":"post /v1/integrations/{integrationId}/auth","title":"Create Integration Auth","href":"/api-reference/integration-auth/create-integration-auth"},{"openapi":"get /v1/integrations/{integrationId}/auth/{authId}","title":"Get Integration Auth","href":"/api-reference/integration-auth/get-integration-auth"},{"openapi":"get /v1/integrations/{integrationId}/auth","title":"List Integration Auth","href":"/api-reference/integration-auth/list-integration-auth"},{"openapi":"patch /v1/integrations/{integrationId}/auth/{authId}","title":"Update Integration Auth","href":"/api-reference/integration-auth/update-integration-auth"},{"openapi":"delete /v1/integrations/{integrationId}/auth/{authId}","title":"Delete Integration Auth","href":"/api-reference/integration-auth/delete-integration-auth"}]},{"group":"Integration Tools","pages":[{"openapi":"post /v1/integrations/{integrationId}/tools","title":"Create Tool","href":"/api-reference/integration-tools/create-tool"},{"openapi":"post /v1/integrations/{integrationId}/tools/{toolId}/execute","title":"Execute Tool","href":"/api-reference/integration-tools/execute-tool"},{"openapi":"get /v1/integrations/{integrationId}/tools/{toolId}","title":"Get Tool","href":"/api-reference/integration-tools/get-tool"},{"openapi":"get /v1/integrations/{integrationId}/tools","title":"List Tools","href":"/api-reference/integration-tools/list-tools"},{"openapi":"patch /v1/integrations/{integrationId}/tools/{toolId}","title":"Update Tool","href":"/api-reference/integration-tools/update-tool"},{"openapi":"delete /v1/integrations/{integrationId}/tools/{toolId}","title":"Delete Tool","href":"/api-reference/integration-tools/delete-tool"}]},{"group":"Mock Tool Data","pages":[{"openapi":"post /v1/mock-tool-data","title":"Create Mock Tool Data","href":"/api-reference/mock-tool-data/create-mock-tool-data"},{"openapi":"get /v1/mock-tool-data/{mockToolDataId}","title":"Get Mock Tool Data","href":"/api-reference/mock-tool-data/get-mock-tool-data"},{"openapi":"get /v1/mock-tool-data","title":"List Mock Tool Data","href":"/api-reference/mock-tool-data/list-mock-tool-data"},{"openapi":"patch /v1/mock-tool-data/{mockToolDataId}","title":"Update Mock Tool Data","href":"/api-reference/mock-tool-data/update-mock-tool-data"},{"openapi":"delete /v1/mock-tool-data/{mockToolDataId}","title":"Delete Mock Tool Data","href":"/api-reference/mock-tool-data/delete-mock-tool-data"}]},{"group":"Test Cases","pages":[{"openapi":"post /v1/test-cases","title":"Create Test Case","href":"/api-reference/test-cases/create-test-case"},{"openapi":"get /v1/test-cases/{testCaseId}","title":"Get Test Case","href":"/api-reference/test-cases/get-test-case"},{"openapi":"get /v1/test-cases","title":"List Test Cases","href":"/api-reference/test-cases/list-test-cases"},{"openapi":"patch /v1/test-cases/{testCaseId}","title":"Update Test Case","href":"/api-reference/test-cases/update-test-case"},{"openapi":"delete /v1/test-cases/{testCaseId}","title":"Delete Test Case","href":"/api-reference/test-cases/delete-test-case"}]},{"group":"Batch","pages":[{"openapi":"post /v1/batch-runs","title":"Create Batch Run","href":"/api-reference/batch/create-batch-run"},{"openapi":"get /v1/batch-runs/{batchId}","title":"Get Batch Run","href":"/api-reference/batch/get-batch-run"},{"openapi":"get /v1/batch-runs","title":"List Batch Runs","href":"/api-reference/batch/list-batch-runs"}]},{"group":"Test Runs","pages":[{"openapi":"get /v1/test-runs/{jobId}","title":"Get Test Run","href":"/api-reference/test-runs/get-test-run"},{"openapi":"get /v1/test-runs","title":"List Test Runs","href":"/api-reference/test-runs/list-test-runs"}]},{"group":"Webhooks","pages":[{"openapi":"post /v1/webhooks","title":"Create Webhook","href":"/api-reference/webhooks/create-webhook"},{"openapi":"get /v1/webhooks/{webhookId}","title":"Get Webhook","href":"/api-reference/webhooks/get-webhook"},{"openapi":"get /v1/webhooks","title":"List Webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"delete /v1/webhooks/{webhookId}","title":"Delete Webhook","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"QA Rules","pages":[{"openapi":"post /v1/qa-rules","title":"Create QA Rule","href":"/api-reference/qa-rules/create-qa-rule"},{"openapi":"get /v1/qa-rules/{qaRuleId}","title":"Get QA Rule","href":"/api-reference/qa-rules/get-qa-rule"},{"openapi":"get /v1/qa-rules","title":"List QA Rules","href":"/api-reference/qa-rules/list-qa-rules"},{"openapi":"patch /v1/qa-rules/{qaRuleId}","title":"Update QA Rule","href":"/api-reference/qa-rules/update-qa-rule"},{"openapi":"delete /v1/qa-rules/{qaRuleId}","title":"Delete QA Rule","href":"/api-reference/qa-rules/delete-qa-rule"}]},{"group":"QA Issues","pages":[{"openapi":"get /v1/qa-issues/{qaIssueId}","title":"Get QA Issue","href":"/api-reference/qa-issues/get-qa-issue"},{"openapi":"get /v1/qa-issues","title":"List QA Issues","href":"/api-reference/qa-issues/list-qa-issues"}]},{"group":"Knowledge bases","pages":[{"openapi":"post /v1/knowledge-bases","title":"Create knowledge base","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"openapi":"get /v1/knowledge-bases/{kbId}","title":"Get knowledge base","href":"/api-reference/knowledge-bases/get-knowledge-base-by-kbid"},{"openapi":"get /v1/knowledge-bases","title":"List knowledge bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"openapi":"patch /v1/knowledge-bases/{kbId}","title":"Update knowledge base","href":"/api-reference/knowledge-bases/update-knowledge-base"},{"openapi":"delete /v1/knowledge-bases/{kbId}","title":"Delete knowledge base","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"openapi":"delete /v1/knowledge-bases/{kbId}/documents/{documentId}","title":"Delete document","href":"/api-reference/knowledge-bases/delete-one-document-from-a-knowledge-base"}]}]},{"tab":"MCP","icon":"code-branch","pages":[{"title":"MCP","href":"/mcp/server"}]},{"tab":"Tutorials","icon":"video","hidden":true,"pages":[{"title":"Tutorials","href":"/tutorials/agents/overview"}]}]},"basePath":"","title":"Update conversational Agent - SigmaMind AI","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}