This is the mode of the welcome message. It can be one of the following: 'assistant-speaks-first', 'assistant-waits-for-user', 'automatic'.
Example:
"assistant-speaks-first"
welcomeMessageInterruptionsEnabled
boolean
default:false
This is a boolean that controls whether the interruptions are enabled during the welcome message. If set to false, the user can not interrupt the welcome message.
List of OpenAI models that can be used for the assistant.
Available options:
gpt-4,
gpt-4o,
gpt-4o-mini,
gpt-3.5-turbo
Example:
"gpt-4o-mini"
assistantLLMUrl
string
Provider your LLM Base URL here when assistantProvider=custom-llm.
Ex: https://your-server.com/custom-llm.
Please note that, we will append /chat/completions to your base URL before calling LLM endpoints.
The LLM URL should be accessible from the Interactly server.
If you are using a local server, you can use ngrok to expose your local server to the internet.
assistantSystemPrompt
string
This system prompt guides the assistant's operations.
Example:
"You are AI assistant to help patients with their health care needs."
assistantTemperature
number
default:0
This is the temperature of the assistant.
Example:
0
assistantMaxTokens
integer
default:256
This is the maximum number of tokens that the assistant can generate.
Example:
256
assistantResponseSplitter
string
Use this Delimiter to split the AI responses into separate lines.
Example:
","
config
object
This is the stt and tts configuration of the assistant. You can add one stt and multiple tts configurations. check here for the list of supported vendors and models.
Show child attributes
hints
string[]
Provide keyword hints to help the assistant better recognize and transcribe important words or phrases.
backgroundSound
enum<string>string<uri>
This is the background sound in the call. Default is 'disable'. You can also provide a custom sound by providing a URL to an audio file. URL should be publicly accessible and should starts with https:// only.
Note: Currently custom sound is not supported in twilio phone vendor.
Available options:
enable,
disable
Maximum string length: 1000
Example:
"enable"
backgroundSoundVolume
number
default:50
This is the volume of the background sound. It is a number between 1 and 100.
Example:
50
ttsCacheEnabled
boolean
This is the enabled flag of the tts cache.
Example:
false
ttsAudioCacheScope
enum<string>
This is the storage scope of the tts audio cache. It can be one of the following: 'assistant', 'team', 'global'. 'global' is deprecated and will be removed in future.
Available options:
assistant,
team,
global
maxConsecutiveTtsFailures
integer
default:2
Maximum number of consecutive TTS turn failures before the call is ended automatically.
Required range: x >= 0
Example:
2
recordingEnabled
boolean
default:true
Controls whether call recording is enabled for this assistant.
Example:
true
recordAfterTransfer
boolean
default:false
When enabled, call recording continues after the call is forwarded or warm-transferred to another party.
Example:
false
postCallTranscriptsEnabled
boolean
default:false
When enabled, a post-call transcript file is generated and stored alongside the call recording after the call ends.
Example:
false
assistantBackchannelingEnabled
boolean
This is the backchanneling enabled of the assistant.
Example:
false
dtmfInputEnabled
boolean
This is a boolean that controls whether the DTMF input is enabled for the assistant.
Example:
false
maxCallDuration
integer
This is the max call duration(in minutes) of the assistant.
Required range: 1 <= x <= 120
Example:
900
idleTimeout
integer
default:30
How long should the assistant wait in silence before confirming the user's presence and playing an idle message?
Required range: 5 <= x <= 600
Example:
20
maxIdleMessagesInSequence
integer
Maximum number of times to repeat the idle message in sequence
Required range: 1 <= x <= 5
Example:
3
startSpeakingOptions
object
Configuration for when the assistant should start talking.
Show child attributes
stopSpeakingOptions
object
Configuration for detecting when when assistant should stop talking on customer interruption.
Show child attributes
userInterruptionAckPlan
object
This is the plan to respond to early interruptions by user with polite filler phrases.
Show child attributes
assistantToolIds
string[]
This is the list of tool IDs of the assistant.
Example:
[]
assistantPredefinedTools
object
Enable or disable specific tools that the assistant can use to improve its functionality.
Show child attributes
assistantType
enum<string>
default:single_prompt
This is the type of the assistant. It can be one of the following: 'single_prompt', 'workflow_based'.
Available options:
single_prompt,
workflow_based
assistantKnowledgeBaseIds
string[]
This is the list of knowledge base IDs of the assistant. Provide only when assistantPredefinedTools.knowledgeBase is enabled
Example:
[]
endCallMessage
string
This is the message that the assistant will say if it ends the call. Provide only when assistantPredefinedTools.endCall is enabled
Example:
"Goodbye!"
endCallToolDescription
string
This is the description of the tool that the assistant will use to end the call. Provide only when assistantPredefinedTools.endCall is enabled
Example:
"Trigger the end call only when the user is done with the conversation."
endCallPhrases
string[]
List of phrases that the assistant will listen to end the call. Provide only when assistantPredefinedTools.endCall is enabled
Example:
["goodbye", "bye"]
callForwardData
object[]
This is the call-forwarding data of the assistant.
Enables warm transfer when forwarding calls. The receiving agent is connected before the caller is transferred, allowing a briefing before handoff. Requires assistantPredefinedTools.callForward to be enabled.
Example:
false
warmTransferConversational
boolean
default:false
When enabled with warmTransferEnabled, the assistant converses with the receiving agent before completing the transfer. When disabled, a pre-generated briefing message is played to the agent instead.
Example:
false
holdMusicUrl
string
default:""
URL of the hold music played to the caller while a conversational warm transfer is in progress. Must be a publicly accessible HTTPS URL.
Maximum time in seconds to wait for the receiving agent to answer during a warm transfer before the transfer is considered failed.
Required range: 1 <= x <= 3600
Example:
300
assistantAnalysis
object
Show child attributes
assistantOverrides
object
This is where you can override the default behavior of the assistant.
Show child attributes
assistantServer
object
This is where Interactly will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
Show child attributes
assistantOutcome
object[]
Show child attributes
smsConfiguration
object
Control how the assistant composes outbound SMS.
Show child attributes
persistHistory
object
Remember users and keep conversation history for follow-ups.
Show child attributes
Response
200 - application/json
Successful response
name
string
This is the name of the assistant.
Example:
"My Assistant"
welcomeMessage
string
default:hi
This is the welcome message of the assistant.
Example:
"Hello! How can I help you?"
welcomeMessageMode
string
default:automatic
This is the mode of the welcome message. It can be one of the following: 'assistant-speaks-first', 'assistant-waits-for-user', 'automatic'.
Example:
"assistant-speaks-first"
welcomeMessageInterruptionsEnabled
boolean
default:false
This is a boolean that controls whether the interruptions are enabled during the welcome message. If set to false, the user can not interrupt the welcome message.
List of OpenAI models that can be used for the assistant.
Available options:
gpt-4,
gpt-4o,
gpt-4o-mini,
gpt-3.5-turbo
Example:
"gpt-4o-mini"
assistantLLMUrl
string
Provider your LLM Base URL here when assistantProvider=custom-llm.
Ex: https://your-server.com/custom-llm.
Please note that, we will append /chat/completions to your base URL before calling LLM endpoints.
The LLM URL should be accessible from the Interactly server.
If you are using a local server, you can use ngrok to expose your local server to the internet.
assistantSystemPrompt
string
This system prompt guides the assistant's operations.
Example:
"You are AI assistant to help patients with their health care needs."
assistantTemperature
number
default:0
This is the temperature of the assistant.
Example:
0
assistantMaxTokens
integer
default:256
This is the maximum number of tokens that the assistant can generate.
Example:
256
assistantResponseSplitter
string
Use this Delimiter to split the AI responses into separate lines.
Example:
","
config
object
This is the stt and tts configuration of the assistant. You can add one stt and multiple tts configurations. check here for the list of supported vendors and models.
Show child attributes
hints
string[]
Provide keyword hints to help the assistant better recognize and transcribe important words or phrases.
backgroundSound
enum<string>string<uri>
This is the background sound in the call. Default is 'disable'. You can also provide a custom sound by providing a URL to an audio file. URL should be publicly accessible and should starts with https:// only.
Note: Currently custom sound is not supported in twilio phone vendor.
Available options:
enable,
disable
Maximum string length: 1000
Example:
"enable"
backgroundSoundVolume
number
default:50
This is the volume of the background sound. It is a number between 1 and 100.
Example:
50
ttsCacheEnabled
boolean
This is the enabled flag of the tts cache.
Example:
false
ttsAudioCacheScope
enum<string>
This is the storage scope of the tts audio cache. It can be one of the following: 'assistant', 'team', 'global'. 'global' is deprecated and will be removed in future.
Available options:
assistant,
team,
global
maxConsecutiveTtsFailures
integer
default:2
Maximum number of consecutive TTS turn failures before the call is ended automatically.
Required range: x >= 0
Example:
2
recordingEnabled
boolean
default:true
Controls whether call recording is enabled for this assistant.
Example:
true
recordAfterTransfer
boolean
default:false
When enabled, call recording continues after the call is forwarded or warm-transferred to another party.
Example:
false
postCallTranscriptsEnabled
boolean
default:false
When enabled, a post-call transcript file is generated and stored alongside the call recording after the call ends.
Example:
false
assistantBackchannelingEnabled
boolean
This is the backchanneling enabled of the assistant.
Example:
false
dtmfInputEnabled
boolean
This is a boolean that controls whether the DTMF input is enabled for the assistant.
Example:
false
maxCallDuration
integer
This is the max call duration(in minutes) of the assistant.
Required range: 1 <= x <= 120
Example:
900
idleTimeout
integer
default:30
How long should the assistant wait in silence before confirming the user's presence and playing an idle message?
Required range: 5 <= x <= 600
Example:
20
maxIdleMessagesInSequence
integer
Maximum number of times to repeat the idle message in sequence
Required range: 1 <= x <= 5
Example:
3
startSpeakingOptions
object
Configuration for when the assistant should start talking.
Show child attributes
stopSpeakingOptions
object
Configuration for detecting when when assistant should stop talking on customer interruption.
Show child attributes
userInterruptionAckPlan
object
This is the plan to respond to early interruptions by user with polite filler phrases.
Show child attributes
assistantToolIds
string[]
This is the list of tool IDs of the assistant.
Example:
[]
assistantPredefinedTools
object
Enable or disable specific tools that the assistant can use to improve its functionality.
Show child attributes
assistantType
enum<string>
default:single_prompt
This is the type of the assistant. It can be one of the following: 'single_prompt', 'workflow_based'.
Available options:
single_prompt,
workflow_based
assistantKnowledgeBaseIds
string[]
This is the list of knowledge base IDs of the assistant. Provide only when assistantPredefinedTools.knowledgeBase is enabled
Example:
[]
endCallMessage
string
This is the message that the assistant will say if it ends the call. Provide only when assistantPredefinedTools.endCall is enabled
Example:
"Goodbye!"
endCallToolDescription
string
This is the description of the tool that the assistant will use to end the call. Provide only when assistantPredefinedTools.endCall is enabled
Example:
"Trigger the end call only when the user is done with the conversation."
endCallPhrases
string[]
List of phrases that the assistant will listen to end the call. Provide only when assistantPredefinedTools.endCall is enabled
Example:
["goodbye", "bye"]
callForwardData
object[]
This is the call-forwarding data of the assistant.
Enables warm transfer when forwarding calls. The receiving agent is connected before the caller is transferred, allowing a briefing before handoff. Requires assistantPredefinedTools.callForward to be enabled.
Example:
false
warmTransferConversational
boolean
default:false
When enabled with warmTransferEnabled, the assistant converses with the receiving agent before completing the transfer. When disabled, a pre-generated briefing message is played to the agent instead.
Example:
false
holdMusicUrl
string
default:""
URL of the hold music played to the caller while a conversational warm transfer is in progress. Must be a publicly accessible HTTPS URL.
Maximum time in seconds to wait for the receiving agent to answer during a warm transfer before the transfer is considered failed.
Required range: 1 <= x <= 3600
Example:
300
assistantAnalysis
object
Show child attributes
assistantOverrides
object
This is where you can override the default behavior of the assistant.
Show child attributes
assistantServer
object
This is where Interactly will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
Show child attributes
assistantOutcome
object[]
Show child attributes
smsConfiguration
object
Control how the assistant composes outbound SMS.
Show child attributes
persistHistory
object
Remember users and keep conversation history for follow-ups.
Show child attributes
_id
string
This is the unique identifier of the assistant.
Example:
"5f7b1b1b1b1b1b1b1b1b1b1b"
teamId
string
This is the unique identifier of the team that the assistant belongs to.
Example:
"1f7b1b1b1b1b1b1b1b1b1b1b"
createdAt
string<date-time>
This is the ISO 8601 date-time string of when the record was created.
Example:
"2020-10-05T00:00:00.000Z"
updatedAt
string<date-time>
This is the ISO 8601 date-time string of when the record was last updated.
Example:
"2020-10-05T00:00:00.000Z"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Interactly API","colors":{"primary":"#1E6EFF","light":"#1E6EFF","dark":"#1E6EFF"},"logo":{"light":"https://mintcdn.com/interactly/ptkIknAxuLhZ0nuk/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=ptkIknAxuLhZ0nuk\u0026q=85\u0026s=1699fd93557b1619c6e3f1d2178e1a98","dark":"https://mintcdn.com/interactly/ptkIknAxuLhZ0nuk/logo/logo_dark.svg?fit=max\u0026auto=format\u0026n=ptkIknAxuLhZ0nuk\u0026q=85\u0026s=3288bfdbdb0359548e380ee02eb228a8"},"favicon":"https://mintcdn.com/interactly/ptkIknAxuLhZ0nuk/logo/favicon.png?fit=max\u0026auto=format\u0026n=ptkIknAxuLhZ0nuk\u0026q=85\u0026s=ba9a8d60e41a25f95e82b23f717a8f7b","api":{"playground":{"display":"interactive","proxy":false}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://interactly.ai","label":"Website"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.interactly.ai"}},"footer":{"socials":{}},"seo":{"indexing":"all"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"interactly","hasAudioNarration":false,"actualSubdomain":"interactly","customDomains":["docs.interactly.ai"],"gitSource":{"type":"github","owner":"interactly","repo":"docs","deployBranch":"prod","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9236e416fcb78afb0a1be:success","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":217},{"language":"default","tag":"Workflows","count":140},{"language":"default","tag":"Campaigns","count":50},{"language":"default","tag":"APIs","count":38},{"language":"default","tag":"Documentation","count":33},{"language":"default","tag":"SMS","count":29},{"language":"default","tag":"Campaigns Calls","count":18},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Simulations","count":13},{"language":"default","tag":"Contacts","count":12}]},"assistantConfig":{},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/assistants/update-assistant","slug":"/api-reference/assistants/update-assistant","pageMetadata":{"title":"Update Assistant","description":"Update Assistant Details by ID","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json patch /assistants/v1/assistants/{id}","href":"/api-reference/assistants/update-assistant","autogeneratedByOpenApi":true},"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: \"Update Assistant Details by ID\"\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":{"title":"Update Assistant","description":"Update Assistant Details by ID","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json patch /assistants/v1/assistants/{id}","href":"/api-reference/assistants/update-assistant","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update Assistant","description":"Update Assistant Details by ID","operationId":"updateAssistant","tags":["Assistants"],"parameters":["c94fc3fc-f0e5-4bb8-a584-f6848141a834"],"requestBody":"fd1f3a04-14dc-4352-9b24-426cf286fb06","responses":{"200":"e83cca3f-143a-4698-ab37-fb284b566197"},"security":["c0ae5dd7-6f42-4a17-87c1-f3d5b8b59c99"],"method":"patch","type":"path","servers":["27fea4b5-1d76-431c-af58-12eeb003b876"],"path":"/assistants/v1/assistants/{id}","baseUrlOptions":["https://api-prod.interactly.ai"],"title":"Update Assistant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"c94fc3fc-f0e5-4bb8-a584-f6848141a834":{"name":"id","in":"path","description":"Assistant ID","required":true,"schema":{"type":"string","isRequired":true,"description":"Assistant ID","uniqueKey":"","typeLabel":"string"},"example":"5f7b1b1b1b1b1b1b1b1b1b1b"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the assistant.","example":"My Assistant","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"welcomeMessage":{"type":"string","description":"This is the welcome message of the assistant.","default":"hi","example":"Hello! How can I help you?","uniqueKey":"welcomeMessage","typeLabel":"string"},"welcomeMessageMode":{"type":"string","description":"This is the mode of the welcome message. It can be one of the following: 'assistant-speaks-first', 'assistant-waits-for-user', 'automatic'.","example":"assistant-speaks-first","default":"automatic","uniqueKey":"welcomeMessageMode","typeLabel":"string"},"welcomeMessageInterruptionsEnabled":{"type":"boolean","description":"This is a boolean that controls whether the interruptions are enabled during the welcome message. If set to false, the user can not interrupt the welcome message.","example":false,"default":false,"uniqueKey":"welcomeMessageInterruptionsEnabled","typeLabel":"boolean"},"assistantProvider":{"type":"string","description":"This is the provider of the assistant.","enum":["openai","azure","gemini","deepseek","bedrock","custom-llm"],"default":"azure","example":"openai","uniqueKey":"assistantProvider","typeLabel":"enum\u003cstring>"},"assistantModel":{"oneOf":[{"type":"string","description":"List of OpenAI models that can be used for the assistant.","default":"gpt-4o-mini","enum":["gpt-4","gpt-4o","gpt-4o-mini","gpt-3.5-turbo"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Azure models that can be used for the assistant.","default":"gpt-4o-mini","enum":["gpt-4","gpt-4o","gpt-4o-mini"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Gemini models that can be used for the assistant.","default":"gpt-4o-mini","enum":["gemini-1.5-flash-latest","gemini-1.5-pro-latest","gemini-1.5-flash"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Deepseek models that can be used for the assistant.","default":"gpt-4o-mini","enum":["V3"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Bedrock models that can be used for the assistant.","default":"gpt-4o-mini","enum":["anthropic.claude-3-5-sonnet","anthropic.claude-3-5-haiku","meta.llama3-1-8b-instruct"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Custom LLM models that can be used for the assistant.","default":"gpt-4o-mini","example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.5","typeLabel":"string"}],"uniqueKey":"assistantModel","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · string"},"assistantLLMUrl":{"type":"string","description":"Provider your LLM Base URL here when `assistantProvider=custom-llm`.\n\nEx: `https://your-server.com/custom-llm`. \n\nPlease note that, we will append `/chat/completions` to your base URL before calling LLM endpoints.\nThe LLM URL should be accessible from the Interactly server.\nIf you are using a local server, you can use ngrok to expose your local server to the internet.","uniqueKey":"assistantLLMUrl","typeLabel":"string"},"assistantSystemPrompt":{"type":"string","description":"This system prompt guides the assistant's operations.","example":"You are AI assistant to help patients with their health care needs.","uniqueKey":"assistantSystemPrompt","typeLabel":"string"},"assistantTemperature":{"type":"number","description":"This is the temperature of the assistant.","default":0,"example":0,"uniqueKey":"assistantTemperature","typeLabel":"number"},"assistantMaxTokens":{"type":"integer","description":"This is the maximum number of tokens that the assistant can generate.","default":256,"example":256,"uniqueKey":"assistantMaxTokens","typeLabel":"integer"},"assistantResponseSplitter":{"type":"string","description":"Use this Delimiter to split the AI responses into separate lines.","example":",","uniqueKey":"assistantResponseSplitter","typeLabel":"string"},"config":{"type":"object","description":"This is the stt and tts configuration of the assistant. You can add one stt and multiple tts configurations. check [here](/vendors) for the list of supported vendors and models.","properties":{"speech":{"type":"object","properties":{"stt":{"oneOf":[{"type":"object","title":"Microsoft STT","description":"This section allows you to configure the transcription settings for the assistant.","properties":{"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"microsoft","default":"microsoft","enum":["microsoft"],"uniqueKey":"config.speech.stt.oneOf.0.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US","en-IN","en-GB","es-US","es-MX","fr-FR","fr-CA","zh-CN","pt-BR","pt-PT","hi-IN"],"uniqueKey":"config.speech.stt.oneOf.0.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.stt.oneOf.0.languages","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"config.speech.stt.oneOf.0","typeLabel":"Microsoft STT · object"},{"type":"object","title":"Deepgram STT","description":"This section allows you to configure the transcription settings for the assistant.","properties":{"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"deepgram","default":"deepgram","enum":["deepgram"],"uniqueKey":"config.speech.stt.oneOf.1.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US"],"uniqueKey":"config.speech.stt.oneOf.1.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.stt.oneOf.1.languages","typeLabel":"enum\u003cstring>[]"},"deepgramOptions":{"type":"object","description":"This is the configuration of the deepgram text to speech.","properties":{"model":{"type":"string","description":"This is the model of the deepgram speech to text.","example":"nova-3","enum":["nova-3","nova-3-medical","nova-2","nova-2-phonecall","nova-2-meeting","nova-2-conversationalai","nova-2-medical","flux-general-en"],"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.model","typeLabel":"enum\u003cstring>"},"punctuate":{"type":"boolean","description":"Enable punctuation in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.punctuate","typeLabel":"boolean"},"endpointing":{"type":"number","description":"The number of seconds of silence after which the speech is considered to be ended. This is set to 10 seconds by default.","example":10,"default":10,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.endpointing","typeLabel":"number"},"smart_format":{"type":"boolean","description":"Enable smart formatting in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.smart_format","typeLabel":"boolean"},"no_delay":{"type":"boolean","description":"Enable no delay in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.no_delay","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"Enable numerals in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.numerals","typeLabel":"boolean"},"eagerEotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.5 by default. Valid Values 0.3 - 0.9. Used for flux-general-en model.","example":0.5,"default":0.5,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.eagerEotThreshold","typeLabel":"number"},"eotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.8 by default. Valid Values 0.5 - 0.9. Used for flux-general-en model.","example":0.8,"default":0.8,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.eotThreshold","typeLabel":"number"},"eotTimeoutMs":{"type":"number","description":"The timeout for the end of turn detection. This is set to 5000 milliseconds by default. Valid Values 100 - 10000 milliseconds. Used for flux-general-en model.","example":5000,"default":5000,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.eotTimeoutMs","typeLabel":"number"}},"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions","typeLabel":"object"}},"uniqueKey":"config.speech.stt.oneOf.1","typeLabel":"Deepgram STT · object"}],"uniqueKey":"config.speech.stt","typeLabel":"Microsoft STT · object | Deepgram STT · object"},"sttFallback":{"oneOf":[{"type":"object","title":"Microsoft STT","description":"This is the fallback speech to text configuration of the assistant. When the main stt configuration fails, the fallback stt configuration will be used. You can enable or disable the fallback stt configuration with `enabled` field.","properties":{"enabled":{"type":"boolean","default":true,"uniqueKey":"config.speech.sttFallback.oneOf.0.enabled","typeLabel":"boolean"},"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"microsoft","default":"microsoft","enum":["microsoft"],"uniqueKey":"config.speech.sttFallback.oneOf.0.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US","en-IN","en-GB","es-US","es-MX","fr-FR","fr-CA","zh-CN","pt-BR","pt-PT","hi-IN"],"uniqueKey":"config.speech.sttFallback.oneOf.0.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.sttFallback.oneOf.0.languages","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"config.speech.sttFallback.oneOf.0","typeLabel":"Microsoft STT · object"},{"type":"object","title":"Deepgram STT","description":"This is the fallback speech to text configuration of the assistant. When the main stt configuration fails, the fallback stt configuration will be used. You can enable or disable the fallback stt configuration with `enabled` field.","properties":{"enabled":{"type":"boolean","default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.enabled","typeLabel":"boolean"},"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"deepgram","default":"deepgram","enum":["deepgram"],"uniqueKey":"config.speech.sttFallback.oneOf.1.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US"],"uniqueKey":"config.speech.sttFallback.oneOf.1.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.sttFallback.oneOf.1.languages","typeLabel":"enum\u003cstring>[]"},"deepgramOptions":{"type":"object","description":"This is the configuration of the deepgram text to speech.","properties":{"model":{"type":"string","description":"This is the model of the deepgram speech to text.","example":"nova-3","enum":["nova-3","nova-3-medical","nova-2","nova-2-phonecall","nova-2-meeting","nova-2-conversationalai","nova-2-medical","flux-general-en"],"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.model","typeLabel":"enum\u003cstring>"},"punctuate":{"type":"boolean","description":"Enable punctuation in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.punctuate","typeLabel":"boolean"},"endpointing":{"type":"number","description":"The number of seconds of silence after which the speech is considered to be ended. This is set to 10 seconds by default.","example":10,"default":10,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.endpointing","typeLabel":"number"},"smart_format":{"type":"boolean","description":"Enable smart formatting in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.smart_format","typeLabel":"boolean"},"no_delay":{"type":"boolean","description":"Enable no delay in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.no_delay","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"Enable numerals in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.numerals","typeLabel":"boolean"},"eagerEotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.5 by default. Valid Values 0.3 - 0.9. Used for flux-general-en model.","example":0.5,"default":0.5,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.eagerEotThreshold","typeLabel":"number"},"eotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.8 by default. Valid Values 0.5 - 0.9. Used for flux-general-en model.","example":0.8,"default":0.8,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.eotThreshold","typeLabel":"number"},"eotTimeoutMs":{"type":"number","description":"The timeout for the end of turn detection. This is set to 5000 milliseconds by default. Valid Values 100 - 10000 milliseconds. Used for flux-general-en model.","example":5000,"default":5000,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.eotTimeoutMs","typeLabel":"number"}},"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions","typeLabel":"object"}},"uniqueKey":"config.speech.sttFallback.oneOf.1","typeLabel":"Deepgram STT · object"}],"uniqueKey":"config.speech.sttFallback","typeLabel":"Microsoft STT · object | Deepgram STT · object"},"ttsData":{"description":"This is the text to speech configuration of the assistant. You can add multiple tts configurations.","type":"array","items":{"oneOf":[{"type":"object","title":"Eleven Labs TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"eleven-labs","enum":["eleven-labs"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en-US","enum":["en-US","es-US","fr-FR","zh-CN","hi-IN"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `ZeK6O9RfGNGj0cJT2HoJ` for `Shanaya (female)-Customer Care Agent` voice.","example":"ZeK6O9RfGNGj0cJT2HoJ","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.voice","typeLabel":"string"},"config":{"type":"object","description":"This is the configuration of the eleven labs text to speech.","properties":{"modelId":{"type":"string","description":"This is the model id of the eleven labs text to speech.","example":"eleven_multilingual_v2","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_flash_v2_5","eleven_turbo_v2","eleven_flash_v2"],"default":"eleven_turbo_v2","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.modelId","typeLabel":"enum\u003cstring>"},"stability":{"type":"number","description":"This is the stability of the eleven labs text to speech.","example":0.7,"default":0.7,"minimum":0,"maximum":1,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Determines how closely the AI should adhere to the original voice when attempting to replicate it.","example":0.85,"default":0.85,"minimum":0,"maximum":1,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.similarityBoost","typeLabel":"number"},"speakerBoost":{"type":"boolean","description":"This is the speaker boost of the eleven labs text to speech.","example":true,"default":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.speakerBoost","typeLabel":"boolean"},"styleExaggeration":{"type":"number","description":"Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.","example":0.5,"default":0,"minimum":0,"maximum":1,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.styleExaggeration","typeLabel":"number"},"seed":{"type":"number","description":"If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295.","example":42,"default":null,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.seed","typeLabel":"number"},"speed":{"type":"number","description":"Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.","example":1,"default":1,"minimum":0.5,"maximum":2,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.speed","typeLabel":"number"},"applyTextNormalization":{"type":"boolean","description":"This is the apply text normalization of the eleven labs text to speech.","example":true,"default":false,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.applyTextNormalization","typeLabel":"boolean"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config","typeLabel":"object"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0","typeLabel":"Eleven Labs TTS · object"},{"type":"object","title":"Deepgram TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"deepgram","enum":["deepgram"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en-US","enum":["en-US","en-UK"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `aura-luna-en` for `Luna (US) Female` voice.","example":"aura-luna-en","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1","typeLabel":"Deepgram TTS · object"},{"type":"object","title":"Microsoft TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"microsoft","enum":["microsoft"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en-US","enum":["en-US","es-ES","fr-FR","hi-In"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `en-US-JennyNeural` for `Jenny (Female)` voice.","example":"en-US-JennyNeural","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.voice","typeLabel":"string"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2","typeLabel":"Microsoft TTS · object"},{"type":"object","title":"Cartesia TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"cartesia","enum":["cartesia"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en","enum":["en","es","fr","zh","hi"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `79f8b5fb-2cc8-479a-80df-29f7a7cf1a3e` for `Nonfiction Man` voice.","example":"79f8b5fb-2cc8-479a-80df-29f7a7cf1a3e","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.voice","typeLabel":"string"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3","typeLabel":"Cartesia TTS · object"}],"uniqueKey":"config.speech.ttsData.items.[INDEX]","typeLabel":"Eleven Labs TTS · object | Deepgram TTS · object | Microsoft TTS · object | Cartesia TTS · object"},"uniqueKey":"config.speech.ttsData","typeLabel":"(Eleven Labs TTS · object | Deepgram TTS · object | Microsoft TTS · object | Cartesia TTS · object)[]"}},"uniqueKey":"config.speech","typeLabel":"object"}},"uniqueKey":"config","typeLabel":"object"},"hints":{"type":"array","description":"Provide keyword hints to help the assistant better recognize and transcribe important words or phrases.","items":{"type":"string","uniqueKey":"hints.items.[INDEX]","typeLabel":"string"},"uniqueKey":"hints","typeLabel":"string[]"},"backgroundSound":{"oneOf":[{"type":"string","title":"Interactly Supported Sounds","description":"This is the background sound in the call. Default is 'disable'. You can also provide a custom sound by providing a URL to an audio file. URL should be publicly accessible and should starts with https:// only. \n\nNote: Currently custom sound is not supported in `twilio` phone vendor.","maxLength":1000,"enum":["enable","disable"],"example":"enable","uniqueKey":"backgroundSound.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Custom Sound URL","description":"This is the background sound in the call. Default is 'disable'. You can also provide a custom sound by providing a URL to an audio file. URL should be publicly accessible and should starts with https:// only. \n\nNote: Currently custom sound is not supported in `twilio` phone vendor.","format":"uri","maxLength":1000,"example":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","uniqueKey":"backgroundSound.oneOf.1","typeLabel":"string\u003curi>"}],"uniqueKey":"backgroundSound","typeLabel":"enum\u003cstring> | string\u003curi>"},"backgroundSoundVolume":{"type":"number","description":"This is the volume of the background sound. It is a number between 1 and 100.","default":50,"example":50,"uniqueKey":"backgroundSoundVolume","typeLabel":"number"},"ttsCacheEnabled":{"type":"boolean","description":"This is the enabled flag of the tts cache.","example":false,"uniqueKey":"ttsCacheEnabled","typeLabel":"boolean"},"ttsAudioCacheScope":{"type":"string","description":"This is the storage scope of the tts audio cache. It can be one of the following: 'assistant', 'team', 'global'. 'global' is deprecated and will be removed in future.","enum":["assistant","team","global"],"uniqueKey":"ttsAudioCacheScope","typeLabel":"enum\u003cstring>"},"maxConsecutiveTtsFailures":{"type":"integer","description":"Maximum number of consecutive TTS turn failures before the call is ended automatically.","default":2,"example":2,"minimum":0,"uniqueKey":"maxConsecutiveTtsFailures","typeLabel":"integer"},"recordingEnabled":{"type":"boolean","description":"Controls whether call recording is enabled for this assistant.","default":true,"example":true,"uniqueKey":"recordingEnabled","typeLabel":"boolean"},"recordAfterTransfer":{"type":"boolean","description":"When enabled, call recording continues after the call is forwarded or warm-transferred to another party.","default":false,"example":false,"uniqueKey":"recordAfterTransfer","typeLabel":"boolean"},"postCallTranscriptsEnabled":{"type":"boolean","description":"When enabled, a post-call transcript file is generated and stored alongside the call recording after the call ends.","default":false,"example":false,"uniqueKey":"postCallTranscriptsEnabled","typeLabel":"boolean"},"assistantBackchannelingEnabled":{"type":"boolean","description":"This is the backchanneling enabled of the assistant.","example":false,"uniqueKey":"assistantBackchannelingEnabled","typeLabel":"boolean"},"dtmfInputEnabled":{"type":"boolean","description":"This is a boolean that controls whether the DTMF input is enabled for the assistant.","example":false,"uniqueKey":"dtmfInputEnabled","typeLabel":"boolean"},"maxCallDuration":{"type":"integer","description":"This is the max call duration(in minutes) of the assistant.","example":900,"minimum":1,"maximum":120,"uniqueKey":"maxCallDuration","typeLabel":"integer"},"idleTimeout":{"type":"integer","description":"How long should the assistant wait in silence before confirming the user's presence and playing an idle message?","default":30,"example":20,"minimum":5,"maximum":600,"uniqueKey":"idleTimeout","typeLabel":"integer"},"maxIdleMessagesInSequence":{"type":"integer","description":"Maximum number of times to repeat the idle message in sequence","example":3,"minimum":1,"maximum":5,"uniqueKey":"maxIdleMessagesInSequence","typeLabel":"integer"},"startSpeakingOptions":{"type":"object","description":"Configuration for when the assistant should start talking.","properties":{"waitSeconds":{"type":"number","description":"Number of seconds to wait before starting to process speech","default":0,"uniqueKey":"startSpeakingOptions.waitSeconds","typeLabel":"number"},"smartEndpointing":{"type":"string","description":"Controls the endpointing strategy for detecting when a user has finished speaking","enum":["Interactly","Off","LiveKit"],"default":"Interactly","uniqueKey":"startSpeakingOptions.smartEndpointing","typeLabel":"enum\u003cstring>"},"onPunctuationSeconds":{"type":"number","description":"The minimum number of seconds to wait after transcription ending with punctuation before sending a request to the model. \n\nThis is only used if `smartEndpointing` is set to `Off`.","default":0,"uniqueKey":"startSpeakingOptions.onPunctuationSeconds","typeLabel":"number"},"onNoPunctuationSeconds":{"type":"number","description":"The minimum number of seconds to wait after transcription ending without punctuation before sending a request to the model. \n\nThis is only used if `smartEndpointing` is set to `Off`.","default":0,"uniqueKey":"startSpeakingOptions.onNoPunctuationSeconds","typeLabel":"number"},"onNumberSeconds":{"type":"number","description":"The minimum number of seconds to wait after transcription ending with a number before sending a request to the model. \n\nThis is only used if `smartEndpointing` is set to `Off`.","default":0,"uniqueKey":"startSpeakingOptions.onNumberSeconds","typeLabel":"number"},"LiveKitBaseValue":{"type":"number","description":"In the expression where X is the probability that the user is still speaking: \n`LiveKitBaseValue + (LiveKitScaleValue * X)`\n This is the base timeout value in milliseconds.\n\nThis is only used if `smartEndpointing` is set to `LiveKit`.","default":100,"uniqueKey":"startSpeakingOptions.LiveKitBaseValue","typeLabel":"number"},"LiveKitScaleValue":{"type":"number","description":"In the expression where X is the probability that the user is still speaking: \n`LiveKitBaseValue + (LiveKitScaleValue * X)`\n This is the scaling factor for LiveKit endpointing that adjusts based on speech probability.\n\nThis is only used if `smartEndpointing` is set to `LiveKit`.","default":1000,"uniqueKey":"startSpeakingOptions.LiveKitScaleValue","typeLabel":"number"}},"uniqueKey":"startSpeakingOptions","typeLabel":"object"},"stopSpeakingOptions":{"type":"object","description":"Configuration for detecting when when assistant should stop talking on customer interruption.","properties":{"numberOfWords":{"type":"number","description":"This is the number of words that the customer has to say before the assistant will stop talking.","default":3,"uniqueKey":"stopSpeakingOptions.numberOfWords","typeLabel":"number"},"voiceSeconds":{"type":"number","description":"This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking.","default":0,"uniqueKey":"stopSpeakingOptions.voiceSeconds","typeLabel":"number"}},"uniqueKey":"stopSpeakingOptions","typeLabel":"object"},"userInterruptionAckPlan":{"type":"object","description":"This is the plan to respond to early interruptions by user with polite filler phrases.","properties":{"enabled":{"type":"boolean","description":"This is the enabled flag of the user interruption ack plan.","uniqueKey":"userInterruptionAckPlan.enabled","typeLabel":"boolean"},"count":{"type":"number","description":"This is the number of times the user will interrupt the assistant before responding with a polite filler phrase.","default":2,"uniqueKey":"userInterruptionAckPlan.count","typeLabel":"number"},"words":{"type":"number","description":"This is the number of words that the user will interrupt the assistant","default":4,"uniqueKey":"userInterruptionAckPlan.words","typeLabel":"number"},"phrases":{"type":"array","description":"This is the list of phrases that the assistant will use to respond to the user's early interruptions.","items":{"type":"string","uniqueKey":"userInterruptionAckPlan.phrases.items.[INDEX]","typeLabel":"string"},"example":["Please hold on while I check your account.","one moment please","let me just check that for you"],"uniqueKey":"userInterruptionAckPlan.phrases","typeLabel":"string[]"}},"uniqueKey":"userInterruptionAckPlan","typeLabel":"object"},"assistantToolIds":{"type":"array","items":{"type":"string","uniqueKey":"assistantToolIds.items.[INDEX]","typeLabel":"string"},"description":"This is the list of tool IDs of the assistant.","example":[],"uniqueKey":"assistantToolIds","typeLabel":"string[]"},"assistantPredefinedTools":{"type":"object","description":"Enable or disable specific tools that the assistant can use to improve its functionality.","properties":{"knowledgeBase":{"type":"boolean","description":"This will allow the assistant to end the call from its side.","default":false,"uniqueKey":"assistantPredefinedTools.knowledgeBase","typeLabel":"boolean"},"endCall":{"type":"boolean","description":"This will allow the assistant to end the call from its side.","default":false,"uniqueKey":"assistantPredefinedTools.endCall","typeLabel":"boolean"},"appointment":{"type":"boolean","description":"This will allow the assistant to manage appointments, including scheduling, rescheduling, and cancellations.","default":false,"uniqueKey":"assistantPredefinedTools.appointment","typeLabel":"boolean"},"volumeControl":{"type":"boolean","description":"This will allow the assistant to adjust the call volume.","default":false,"uniqueKey":"assistantPredefinedTools.volumeControl","typeLabel":"boolean"},"waitList":{"type":"boolean","description":"This will allow the assistant to access the wait list.","default":false,"uniqueKey":"assistantPredefinedTools.waitList","typeLabel":"boolean"},"callForward":{"type":"boolean","description":"This will allow the assistant to forward calls to the desired recipient or queue.","default":false,"uniqueKey":"assistantPredefinedTools.callForward","typeLabel":"boolean"},"sendSms":{"type":"boolean","description":"This will allow the assistant to send SMS messages during the call.","default":false,"uniqueKey":"assistantPredefinedTools.sendSms","typeLabel":"boolean"}},"uniqueKey":"assistantPredefinedTools","typeLabel":"object"},"assistantType":{"type":"string","description":"This is the type of the assistant. It can be one of the following: 'single_prompt', 'workflow_based'.","enum":["single_prompt","workflow_based"],"default":"single_prompt","uniqueKey":"assistantType","typeLabel":"enum\u003cstring>"},"assistantKnowledgeBaseIds":{"type":"array","items":{"type":"string","uniqueKey":"assistantKnowledgeBaseIds.items.[INDEX]","typeLabel":"string"},"description":"This is the list of knowledge base IDs of the assistant. Provide only when `assistantPredefinedTools.knowledgeBase` is enabled","example":[],"uniqueKey":"assistantKnowledgeBaseIds","typeLabel":"string[]"},"endCallMessage":{"type":"string","description":"This is the message that the assistant will say if it ends the call. Provide only when `assistantPredefinedTools.endCall` is enabled","example":"Goodbye!","uniqueKey":"endCallMessage","typeLabel":"string"},"endCallToolDescription":{"type":"string","description":"This is the description of the tool that the assistant will use to end the call. Provide only when `assistantPredefinedTools.endCall` is enabled","example":"Trigger the end call only when the user is done with the conversation.","uniqueKey":"endCallToolDescription","typeLabel":"string"},"endCallPhrases":{"type":"array","description":"List of phrases that the assistant will listen to end the call. Provide only when `assistantPredefinedTools.endCall` is enabled","items":{"type":"string","uniqueKey":"endCallPhrases.items.[INDEX]","typeLabel":"string"},"example":["goodbye","bye"],"uniqueKey":"endCallPhrases","typeLabel":"string[]"},"callForwardData":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number used to forward the call.","example":"+1234567890","uniqueKey":"callForwardData.items.[INDEX].phoneNumber","typeLabel":"string"},"extension":{"type":"string","description":"This is the extension of the assistant. Leave it empty if there is no extension.","example":"","uniqueKey":"callForwardData.items.[INDEX].extension","typeLabel":"string"},"name":{"type":"string","description":"This is a friendly name for the call forward.","example":"call-forward-name","uniqueKey":"callForwardData.items.[INDEX].name","typeLabel":"string"},"onFailedMessage":{"type":"string","description":"This is the message that the assistant will say if the call forward fails.","example":"The call forward failed. Please try again later.","required":false,"uniqueKey":"callForwardData.items.[INDEX].onFailedMessage","typeLabel":"string"}},"uniqueKey":"callForwardData.items.[INDEX]","typeLabel":"object"},"description":"This is the call-forwarding data of the assistant.","example":{"phoneNumber":"+1234567890","extension":"","name":"call-forward-name"},"uniqueKey":"callForwardData","typeLabel":"object[]"},"warmTransferEnabled":{"type":"boolean","description":"Enables warm transfer when forwarding calls. The receiving agent is connected before the caller is transferred, allowing a briefing before handoff. Requires `assistantPredefinedTools.callForward` to be enabled.","default":false,"example":false,"uniqueKey":"warmTransferEnabled","typeLabel":"boolean"},"warmTransferConversational":{"type":"boolean","description":"When enabled with `warmTransferEnabled`, the assistant converses with the receiving agent before completing the transfer. When disabled, a pre-generated briefing message is played to the agent instead.","default":false,"example":false,"uniqueKey":"warmTransferConversational","typeLabel":"boolean"},"holdMusicUrl":{"type":"string","description":"URL of the hold music played to the caller while a conversational warm transfer is in progress. Must be a publicly accessible HTTPS URL.","default":"","example":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","uniqueKey":"holdMusicUrl","typeLabel":"string"},"warmTransferTimeout":{"type":"integer","description":"Maximum time in seconds to wait for the receiving agent to answer during a warm transfer before the transfer is considered failed.","default":300,"example":300,"minimum":1,"maximum":3600,"uniqueKey":"warmTransferTimeout","typeLabel":"integer"},"assistantAnalysis":{"type":"object","properties":{"summary":{"type":"object","description":"This is the plan for generating the summary of the call. This outputs to `call.analysis.summary`.","properties":{"enabled":{"type":"boolean","description":"This is a boolean that controls whether the summary is generated. If set to false, the model will not generate a summary of the call.\n\n@default false","example":false,"uniqueKey":"assistantAnalysis.summary.enabled","typeLabel":"boolean"},"prompt":{"type":"string","description":"This is the prompt that the model will use to generate the summary of the call.","example":"Generate a summary of the call.","uniqueKey":"assistantAnalysis.summary.prompt","typeLabel":"string"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty. \n Usage: \n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond. \n @default 5 seconds","minimum":1,"maximum":60,"example":30,"uniqueKey":"assistantAnalysis.summary.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"assistantAnalysis.summary","typeLabel":"object"},"successEvaluation":{"type":"object","description":"This is the plan for generating the success evaluation of the call. This outputs to `call.analysis.successEvaluation`.","properties":{"enabled":{"type":"boolean","description":"This is a boolean that controls whether the success evaluation is generated. If set to false, the model will not generate a success evaluation of the call.\n\n@default false","example":false,"uniqueKey":"assistantAnalysis.successEvaluation.enabled","typeLabel":"boolean"},"prompt":{"type":"string","description":"This is the prompt that the model will use to generate the success evaluation of the call.","example":"Evaluate the success of the call.","uniqueKey":"assistantAnalysis.successEvaluation.prompt","typeLabel":"string"},"rubric":{"type":"string","enum":["NumericScale","DescriptiveScale","Checklist","Matrix","PercentageScale","LikertScale","AutomaticRubric","PassFail"],"description":"This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`.\n\nOptions include:\n- 'NumericScale': A scale of 1 to 10.\n- 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.\n- 'Checklist': A checklist of criteria and their status.\n- 'Matrix': A grid that evaluates multiple criteria across different performance levels.\n- 'PercentageScale': A scale of 0% to 100%.\n- 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly Disagree.\n- 'AutomaticRubric': Automatically break down evaluation into several criteria, each with its own score.\n- 'PassFail': A simple 'true' if call passed, 'false' if not.\n\nDefault is 'PassFail'.","uniqueKey":"assistantAnalysis.successEvaluation.rubric","typeLabel":"enum\u003cstring>"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty. \n Usage: \n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond. \n @default 5 seconds","minimum":1,"maximum":60,"example":30,"uniqueKey":"assistantAnalysis.successEvaluation.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"assistantAnalysis.successEvaluation","typeLabel":"object"},"structuredData":{"type":"object","description":"This is the plan for generating the structured data from the call. This outputs to `call.analysis.structuredData`.","properties":{"enabled":{"type":"boolean","description":"This determines whether structured data is generated and stored in `call.analysis.structuredData`. Defaults to false.\n\nUsage:\n- If you want to extract structured data, set this to true and provide a `schema`.\n\n@default false","default":false,"uniqueKey":"assistantAnalysis.structuredData.enabled","typeLabel":"boolean"},"prompt":{"type":"string","description":"This is the prompt that the model will use to generate the structured data of the call.","example":"Extract structured data from the call.","uniqueKey":"assistantAnalysis.structuredData.prompt","typeLabel":"string"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.structuredData` will be empty.\n\nUsage:\n- To guarantee the structured data is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"example":30,"uniqueKey":"assistantAnalysis.structuredData.timeoutSeconds","typeLabel":"number"},"schema":{"type":"object","description":"This is the schema of the structured data. The output is stored in `call.analysis.structuredData`.\n\nComplete guide on JSON Schema can be found [here](https://ajv.js.org/json-schema.html#json-data-type).","required":["type"],"example":{"type":"object","properties":{"name":{"type":"string","description":"This is the name of the user.","example":"John Doe"},"dob":{"type":"string","format":"date","description":"This is the date of birth of the user.","example":"1990-03-08"}}},"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"assistantAnalysis.structuredData.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"assistantAnalysis.structuredData.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"assistantAnalysis.structuredData.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"assistantAnalysis.structuredData.schema.description","typeLabel":"string"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"assistantAnalysis.structuredData.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"assistantAnalysis.structuredData.schema.required","typeLabel":"string[]"}},"uniqueKey":"assistantAnalysis.structuredData.schema","typeLabel":"object"}},"uniqueKey":"assistantAnalysis.structuredData","typeLabel":"object"}},"uniqueKey":"assistantAnalysis","typeLabel":"object"},"assistantOverrides":{"type":"object","description":"This is where you can override the default behavior of the assistant.","properties":{"welcomeMessage":{"type":"string","description":"This is the message that the assistant will say when the call starts.","example":"Hello, how can I help you today?","uniqueKey":"assistantOverrides.welcomeMessage","typeLabel":"string"},"welcomeMessageMode":{"type":"string","description":"This is the mode of the welcome message. It can be one of the following: 'assistant-speaks-first', 'assistant-waits-for-user', 'automatic'.","example":"assistant-speaks-first","default":"automatic","uniqueKey":"assistantOverrides.welcomeMessageMode","typeLabel":"string"},"welcomeMessageInterruptionsEnabled":{"type":"boolean","description":"This is a boolean that controls whether the interruptions are enabled during the welcome message. If set to false, the user can not interrupt the welcome message.","example":false,"default":false,"uniqueKey":"assistantOverrides.welcomeMessageInterruptionsEnabled","typeLabel":"boolean"},"recordingEnabled":{"type":"boolean","description":"This is a boolean that controls whether the recording is enabled. If set to false, the model will not record the call.\n\n@default true","default":true,"example":true,"uniqueKey":"assistantOverrides.recordingEnabled","typeLabel":"boolean"},"recordAfterTransfer":{"type":"boolean","description":"When enabled, call recording continues after the call is forwarded or warm-transferred to another party.","default":false,"example":false,"uniqueKey":"assistantOverrides.recordAfterTransfer","typeLabel":"boolean"},"postCallTranscriptsEnabled":{"type":"boolean","description":"When enabled, a post-call transcript file is generated and stored alongside the call recording after the call ends.","default":false,"example":false,"uniqueKey":"assistantOverrides.postCallTranscriptsEnabled","typeLabel":"boolean"},"maxConsecutiveTtsFailures":{"type":"integer","description":"Maximum number of consecutive TTS turn failures before the call is ended automatically.","default":2,"example":2,"minimum":0,"uniqueKey":"assistantOverrides.maxConsecutiveTtsFailures","typeLabel":"integer"},"warmTransferEnabled":{"type":"boolean","description":"Enables warm transfer when forwarding calls. The receiving agent is connected before the caller is transferred.","default":false,"example":false,"uniqueKey":"assistantOverrides.warmTransferEnabled","typeLabel":"boolean"},"warmTransferConversational":{"type":"boolean","description":"When enabled with `warmTransferEnabled`, the assistant converses with the receiving agent via WebSocket before completing the transfer.","default":false,"example":false,"uniqueKey":"assistantOverrides.warmTransferConversational","typeLabel":"boolean"},"holdMusicUrl":{"type":"string","description":"URL of the hold music played to the caller while a conversational warm transfer is in progress.","default":"","example":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","uniqueKey":"assistantOverrides.holdMusicUrl","typeLabel":"string"},"warmTransferTimeout":{"type":"integer","description":"Maximum time in seconds to wait for the receiving agent to answer during a warm transfer.","default":300,"example":300,"minimum":1,"maximum":3600,"uniqueKey":"assistantOverrides.warmTransferTimeout","typeLabel":"integer"},"recordingPath":{"type":"string","description":"This is the path where the recording will be stored. If not provided, the recording will be stored in the default path.","example":"/recordings","uniqueKey":"assistantOverrides.recordingPath","typeLabel":"string"},"dynamicVariables":{"type":"object","description":"This is the dynamic variables of the conversation. Values in this object will be replaced in the assistant system prompt, welcome message, end call message. If your dynamic variable is `user_name`, you can use it in the system prompt message as `Hello, {{user_name}}`.","example":{"user_name":"John Doe"},"uniqueKey":"assistantOverrides.dynamicVariables","typeLabel":"object"}},"uniqueKey":"assistantOverrides","typeLabel":"object"},"assistantServer":{"type":"object","description":"This is where Interactly will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.","required":["url"],"properties":{"url":{"type":"string","description":"API endpoint to send requests to.","example":"https://api.example.com/v1/getUserDetails","isRequired":true,"uniqueKey":"assistantServer.url","typeLabel":"string"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request to your server. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":120,"example":20,"uniqueKey":"assistantServer.timeoutSeconds","typeLabel":"number"},"secret":{"type":"string","description":"This is the secret you can set that Interactly will send with every request to your server. Will be sent as a header called x-interactly-secret.","example":"my-secret","uniqueKey":"assistantServer.secret","typeLabel":"string"},"headers":{"type":"object","description":"These are the custom headers to include in the request sent to your server.\n\nEach key-value pair represents a header name and its value.","example":{},"uniqueKey":"assistantServer.headers","typeLabel":"object"},"enabled":{"type":"boolean","description":"This is a boolean that controls whether the server is enabled. If set to false, the model will not send webhooks to the server.\n\n@default false","example":false,"uniqueKey":"assistantServer.enabled","typeLabel":"boolean"},"messages":{"type":"array","enum":["status-update","conversation-update","hang","end-of-call-report","error"],"example":["status-update","conversation-update","hang","end-of-call-report","error"],"description":"These are the messages that will be sent to your Server URL.","items":{"type":"string","enum":["status-update","conversation-update","hang","end-of-call-report","error"],"uniqueKey":"assistantServer.messages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"assistantServer.messages","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"assistantServer","typeLabel":"object"},"assistantOutcome":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the outcome.","uniqueKey":"assistantOutcome.items.[INDEX].type","typeLabel":"string"},"field":{"type":"string","description":"This is the field of the outcome.","uniqueKey":"assistantOutcome.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"assistantOutcome.items.[INDEX]","typeLabel":"object"},"uniqueKey":"assistantOutcome","typeLabel":"object[]"},"smsConfiguration":{"type":"object","description":"Control how the assistant composes outbound SMS.","properties":{"enabled":{"type":"boolean","description":"This is the enabled flag of the sms configuration.","uniqueKey":"smsConfiguration.enabled","typeLabel":"boolean"},"sameAsAssistant":{"type":"boolean","description":"Use the same prompt as the assistant, or provide a custom SMS prompt.","uniqueKey":"smsConfiguration.sameAsAssistant","typeLabel":"boolean"},"smsPrompt":{"type":"string","description":"This is the sms prompt for handling sms responses.","uniqueKey":"smsConfiguration.smsPrompt","typeLabel":"string"}},"uniqueKey":"smsConfiguration","typeLabel":"object"},"persistHistory":{"type":"object","description":"Remember users and keep conversation history for follow-ups.","properties":{"enabled":{"type":"boolean","description":"This is the enabled flag of the persist history.","uniqueKey":"persistHistory.enabled","typeLabel":"boolean"},"call":{"type":"boolean","description":"Store metadata and transcripts of calls in persisted data for future personalization and context.","uniqueKey":"persistHistory.call","typeLabel":"boolean"},"sms":{"type":"boolean","description":"Keep outbound and inbound SMS content so follow-ups can reference earlier messages.","uniqueKey":"persistHistory.sms","typeLabel":"boolean"},"retentionPeriod":{"type":"number","description":"This is, how long(in number of days) to retain persisted data. Set to 0 to keep nothing.","example":7,"uniqueKey":"persistHistory.retentionPeriod","typeLabel":"number"}},"uniqueKey":"persistHistory","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"My Assistant","welcomeMessage":"Hello! How can I help you?","welcomeMessageMode":"assistant-speaks-first","welcomeMessageInterruptionsEnabled":false,"assistantProvider":"openai","assistantModel":"gpt-4o-mini","assistantLLMUrl":"\u003cstring>","assistantSystemPrompt":"You are AI assistant to help patients with their health care needs.","assistantTemperature":0,"assistantMaxTokens":256,"assistantResponseSplitter":",","config":{"speech":{"stt":{"vendor":"microsoft","languages":"en-US"},"sttFallback":{"enabled":true,"vendor":"microsoft","languages":"en-US"},"ttsData":[{"enabled":true,"vendor":"eleven-labs","language":"en-US","voice":"ZeK6O9RfGNGj0cJT2HoJ","config":{"modelId":"eleven_multilingual_v2","stability":0.7,"similarityBoost":0.85,"speakerBoost":true,"styleExaggeration":0.5,"seed":42,"speed":1,"applyTextNormalization":true}}]}},"hints":["\u003cstring>"],"backgroundSound":"enable","backgroundSoundVolume":50,"ttsCacheEnabled":false,"maxConsecutiveTtsFailures":2,"recordingEnabled":true,"recordAfterTransfer":false,"postCallTranscriptsEnabled":false,"assistantBackchannelingEnabled":false,"dtmfInputEnabled":false,"maxCallDuration":900,"idleTimeout":20,"maxIdleMessagesInSequence":3,"startSpeakingOptions":{"waitSeconds":0,"smartEndpointing":"Interactly","onPunctuationSeconds":0,"onNoPunctuationSeconds":0,"onNumberSeconds":0,"LiveKitBaseValue":100,"LiveKitScaleValue":1000},"stopSpeakingOptions":{"numberOfWords":3,"voiceSeconds":0},"userInterruptionAckPlan":{"enabled":true,"count":2,"words":4,"phrases":["Please hold on while I check your account.","one moment please","let me just check that for you"]},"assistantToolIds":[],"assistantPredefinedTools":{"knowledgeBase":false,"endCall":false,"appointment":false,"volumeControl":false,"waitList":false,"callForward":false,"sendSms":false},"assistantType":"single_prompt","assistantKnowledgeBaseIds":[],"endCallMessage":"Goodbye!","endCallToolDescription":"Trigger the end call only when the user is done with the conversation.","endCallPhrases":["goodbye","bye"],"callForwardData":{"phoneNumber":"+1234567890","extension":"","name":"call-forward-name"},"warmTransferEnabled":false,"warmTransferConversational":false,"holdMusicUrl":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","warmTransferTimeout":300,"assistantAnalysis":{"summary":{"enabled":false,"prompt":"Generate a summary of the call.","timeoutSeconds":30},"successEvaluation":{"enabled":false,"prompt":"Evaluate the success of the call.","timeoutSeconds":30},"structuredData":{"enabled":false,"prompt":"Extract structured data from the call.","timeoutSeconds":30,"schema":{"type":"object","properties":{"name":{"type":"string","description":"This is the name of the user.","example":"John Doe"},"dob":{"type":"string","format":"date","description":"This is the date of birth of the user.","example":"1990-03-08"}}}}},"assistantOverrides":{"welcomeMessage":"Hello, how can I help you today?","welcomeMessageMode":"assistant-speaks-first","welcomeMessageInterruptionsEnabled":false,"recordingEnabled":true,"recordAfterTransfer":false,"postCallTranscriptsEnabled":false,"maxConsecutiveTtsFailures":2,"warmTransferEnabled":false,"warmTransferConversational":false,"holdMusicUrl":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","warmTransferTimeout":300,"recordingPath":"/recordings","dynamicVariables":{"user_name":"John Doe"}},"assistantOutcome":[{"type":"\u003cstring>","field":"\u003cstring>"}],"smsConfiguration":{"enabled":true,"sameAsAssistant":true,"smsPrompt":"\u003cstring>"},"persistHistory":{"enabled":true,"call":true,"sms":true,"retentionPeriod":7}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"e83cca3f-143a-4698-ab37-fb284b566197":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"This is the name of the assistant.","example":"My Assistant","uniqueKey":"name","typeLabel":"string"},"welcomeMessage":{"type":"string","description":"This is the welcome message of the assistant.","default":"hi","example":"Hello! How can I help you?","uniqueKey":"welcomeMessage","typeLabel":"string"},"welcomeMessageMode":{"type":"string","description":"This is the mode of the welcome message. It can be one of the following: 'assistant-speaks-first', 'assistant-waits-for-user', 'automatic'.","example":"assistant-speaks-first","default":"automatic","uniqueKey":"welcomeMessageMode","typeLabel":"string"},"welcomeMessageInterruptionsEnabled":{"type":"boolean","description":"This is a boolean that controls whether the interruptions are enabled during the welcome message. If set to false, the user can not interrupt the welcome message.","example":false,"default":false,"uniqueKey":"welcomeMessageInterruptionsEnabled","typeLabel":"boolean"},"assistantProvider":{"type":"string","description":"This is the provider of the assistant.","enum":["openai","azure","gemini","deepseek","bedrock","custom-llm"],"default":"azure","example":"openai","uniqueKey":"assistantProvider","typeLabel":"enum\u003cstring>"},"assistantModel":{"oneOf":[{"type":"string","description":"List of OpenAI models that can be used for the assistant.","default":"gpt-4o-mini","enum":["gpt-4","gpt-4o","gpt-4o-mini","gpt-3.5-turbo"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Azure models that can be used for the assistant.","default":"gpt-4o-mini","enum":["gpt-4","gpt-4o","gpt-4o-mini"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Gemini models that can be used for the assistant.","default":"gpt-4o-mini","enum":["gemini-1.5-flash-latest","gemini-1.5-pro-latest","gemini-1.5-flash"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Deepseek models that can be used for the assistant.","default":"gpt-4o-mini","enum":["V3"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Bedrock models that can be used for the assistant.","default":"gpt-4o-mini","enum":["anthropic.claude-3-5-sonnet","anthropic.claude-3-5-haiku","meta.llama3-1-8b-instruct"],"example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"string","description":"List of Custom LLM models that can be used for the assistant.","default":"gpt-4o-mini","example":"gpt-4o-mini","uniqueKey":"assistantModel.oneOf.5","typeLabel":"string"}],"uniqueKey":"assistantModel","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · string"},"assistantLLMUrl":{"type":"string","description":"Provider your LLM Base URL here when `assistantProvider=custom-llm`.\n\nEx: `https://your-server.com/custom-llm`. \n\nPlease note that, we will append `/chat/completions` to your base URL before calling LLM endpoints.\nThe LLM URL should be accessible from the Interactly server.\nIf you are using a local server, you can use ngrok to expose your local server to the internet.","uniqueKey":"assistantLLMUrl","typeLabel":"string"},"assistantSystemPrompt":{"type":"string","description":"This system prompt guides the assistant's operations.","example":"You are AI assistant to help patients with their health care needs.","uniqueKey":"assistantSystemPrompt","typeLabel":"string"},"assistantTemperature":{"type":"number","description":"This is the temperature of the assistant.","default":0,"example":0,"uniqueKey":"assistantTemperature","typeLabel":"number"},"assistantMaxTokens":{"type":"integer","description":"This is the maximum number of tokens that the assistant can generate.","default":256,"example":256,"uniqueKey":"assistantMaxTokens","typeLabel":"integer"},"assistantResponseSplitter":{"type":"string","description":"Use this Delimiter to split the AI responses into separate lines.","example":",","uniqueKey":"assistantResponseSplitter","typeLabel":"string"},"config":{"type":"object","description":"This is the stt and tts configuration of the assistant. You can add one stt and multiple tts configurations. check [here](/vendors) for the list of supported vendors and models.","properties":{"speech":{"type":"object","properties":{"stt":{"oneOf":[{"type":"object","title":"Microsoft STT","description":"This section allows you to configure the transcription settings for the assistant.","properties":{"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"microsoft","default":"microsoft","enum":["microsoft"],"uniqueKey":"config.speech.stt.oneOf.0.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US","en-IN","en-GB","es-US","es-MX","fr-FR","fr-CA","zh-CN","pt-BR","pt-PT","hi-IN"],"uniqueKey":"config.speech.stt.oneOf.0.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.stt.oneOf.0.languages","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"config.speech.stt.oneOf.0","typeLabel":"Microsoft STT · object"},{"type":"object","title":"Deepgram STT","description":"This section allows you to configure the transcription settings for the assistant.","properties":{"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"deepgram","default":"deepgram","enum":["deepgram"],"uniqueKey":"config.speech.stt.oneOf.1.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US"],"uniqueKey":"config.speech.stt.oneOf.1.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.stt.oneOf.1.languages","typeLabel":"enum\u003cstring>[]"},"deepgramOptions":{"type":"object","description":"This is the configuration of the deepgram text to speech.","properties":{"model":{"type":"string","description":"This is the model of the deepgram speech to text.","example":"nova-3","enum":["nova-3","nova-3-medical","nova-2","nova-2-phonecall","nova-2-meeting","nova-2-conversationalai","nova-2-medical","flux-general-en"],"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.model","typeLabel":"enum\u003cstring>"},"punctuate":{"type":"boolean","description":"Enable punctuation in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.punctuate","typeLabel":"boolean"},"endpointing":{"type":"number","description":"The number of seconds of silence after which the speech is considered to be ended. This is set to 10 seconds by default.","example":10,"default":10,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.endpointing","typeLabel":"number"},"smart_format":{"type":"boolean","description":"Enable smart formatting in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.smart_format","typeLabel":"boolean"},"no_delay":{"type":"boolean","description":"Enable no delay in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.no_delay","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"Enable numerals in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.numerals","typeLabel":"boolean"},"eagerEotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.5 by default. Valid Values 0.3 - 0.9. Used for flux-general-en model.","example":0.5,"default":0.5,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.eagerEotThreshold","typeLabel":"number"},"eotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.8 by default. Valid Values 0.5 - 0.9. Used for flux-general-en model.","example":0.8,"default":0.8,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.eotThreshold","typeLabel":"number"},"eotTimeoutMs":{"type":"number","description":"The timeout for the end of turn detection. This is set to 5000 milliseconds by default. Valid Values 100 - 10000 milliseconds. Used for flux-general-en model.","example":5000,"default":5000,"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions.eotTimeoutMs","typeLabel":"number"}},"uniqueKey":"config.speech.stt.oneOf.1.deepgramOptions","typeLabel":"object"}},"uniqueKey":"config.speech.stt.oneOf.1","typeLabel":"Deepgram STT · object"}],"uniqueKey":"config.speech.stt","typeLabel":"Microsoft STT · object | Deepgram STT · object"},"sttFallback":{"oneOf":[{"type":"object","title":"Microsoft STT","description":"This is the fallback speech to text configuration of the assistant. When the main stt configuration fails, the fallback stt configuration will be used. You can enable or disable the fallback stt configuration with `enabled` field.","properties":{"enabled":{"type":"boolean","default":true,"uniqueKey":"config.speech.sttFallback.oneOf.0.enabled","typeLabel":"boolean"},"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"microsoft","default":"microsoft","enum":["microsoft"],"uniqueKey":"config.speech.sttFallback.oneOf.0.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US","en-IN","en-GB","es-US","es-MX","fr-FR","fr-CA","zh-CN","pt-BR","pt-PT","hi-IN"],"uniqueKey":"config.speech.sttFallback.oneOf.0.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.sttFallback.oneOf.0.languages","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"config.speech.sttFallback.oneOf.0","typeLabel":"Microsoft STT · object"},{"type":"object","title":"Deepgram STT","description":"This is the fallback speech to text configuration of the assistant. When the main stt configuration fails, the fallback stt configuration will be used. You can enable or disable the fallback stt configuration with `enabled` field.","properties":{"enabled":{"type":"boolean","default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.enabled","typeLabel":"boolean"},"vendor":{"type":"string","description":"This is the vendor of the speech to text.","example":"deepgram","default":"deepgram","enum":["deepgram"],"uniqueKey":"config.speech.sttFallback.oneOf.1.vendor","typeLabel":"enum\u003cstring>"},"languages":{"type":"array","description":"This is the list of languages that the assistant can understand.","items":{"type":"string","enum":["en-US"],"uniqueKey":"config.speech.sttFallback.oneOf.1.languages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"en-US","default":["en-US"],"uniqueKey":"config.speech.sttFallback.oneOf.1.languages","typeLabel":"enum\u003cstring>[]"},"deepgramOptions":{"type":"object","description":"This is the configuration of the deepgram text to speech.","properties":{"model":{"type":"string","description":"This is the model of the deepgram speech to text.","example":"nova-3","enum":["nova-3","nova-3-medical","nova-2","nova-2-phonecall","nova-2-meeting","nova-2-conversationalai","nova-2-medical","flux-general-en"],"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.model","typeLabel":"enum\u003cstring>"},"punctuate":{"type":"boolean","description":"Enable punctuation in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.punctuate","typeLabel":"boolean"},"endpointing":{"type":"number","description":"The number of seconds of silence after which the speech is considered to be ended. This is set to 10 seconds by default.","example":10,"default":10,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.endpointing","typeLabel":"number"},"smart_format":{"type":"boolean","description":"Enable smart formatting in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.smart_format","typeLabel":"boolean"},"no_delay":{"type":"boolean","description":"Enable no delay in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.no_delay","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"Enable numerals in the transcription output. This is enabled by default.","example":true,"default":true,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.numerals","typeLabel":"boolean"},"eagerEotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.5 by default. Valid Values 0.3 - 0.9. Used for flux-general-en model.","example":0.5,"default":0.5,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.eagerEotThreshold","typeLabel":"number"},"eotThreshold":{"type":"number","description":"The threshold for the end of turn detection. This is set to 0.8 by default. Valid Values 0.5 - 0.9. Used for flux-general-en model.","example":0.8,"default":0.8,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.eotThreshold","typeLabel":"number"},"eotTimeoutMs":{"type":"number","description":"The timeout for the end of turn detection. This is set to 5000 milliseconds by default. Valid Values 100 - 10000 milliseconds. Used for flux-general-en model.","example":5000,"default":5000,"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions.eotTimeoutMs","typeLabel":"number"}},"uniqueKey":"config.speech.sttFallback.oneOf.1.deepgramOptions","typeLabel":"object"}},"uniqueKey":"config.speech.sttFallback.oneOf.1","typeLabel":"Deepgram STT · object"}],"uniqueKey":"config.speech.sttFallback","typeLabel":"Microsoft STT · object | Deepgram STT · object"},"ttsData":{"description":"This is the text to speech configuration of the assistant. You can add multiple tts configurations.","type":"array","items":{"oneOf":[{"type":"object","title":"Eleven Labs TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"eleven-labs","enum":["eleven-labs"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en-US","enum":["en-US","es-US","fr-FR","zh-CN","hi-IN"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `ZeK6O9RfGNGj0cJT2HoJ` for `Shanaya (female)-Customer Care Agent` voice.","example":"ZeK6O9RfGNGj0cJT2HoJ","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.voice","typeLabel":"string"},"config":{"type":"object","description":"This is the configuration of the eleven labs text to speech.","properties":{"modelId":{"type":"string","description":"This is the model id of the eleven labs text to speech.","example":"eleven_multilingual_v2","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_flash_v2_5","eleven_turbo_v2","eleven_flash_v2"],"default":"eleven_turbo_v2","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.modelId","typeLabel":"enum\u003cstring>"},"stability":{"type":"number","description":"This is the stability of the eleven labs text to speech.","example":0.7,"default":0.7,"minimum":0,"maximum":1,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Determines how closely the AI should adhere to the original voice when attempting to replicate it.","example":0.85,"default":0.85,"minimum":0,"maximum":1,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.similarityBoost","typeLabel":"number"},"speakerBoost":{"type":"boolean","description":"This is the speaker boost of the eleven labs text to speech.","example":true,"default":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.speakerBoost","typeLabel":"boolean"},"styleExaggeration":{"type":"number","description":"Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.","example":0.5,"default":0,"minimum":0,"maximum":1,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.styleExaggeration","typeLabel":"number"},"seed":{"type":"number","description":"If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295.","example":42,"default":null,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.seed","typeLabel":"number"},"speed":{"type":"number","description":"Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.","example":1,"default":1,"minimum":0.5,"maximum":2,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.speed","typeLabel":"number"},"applyTextNormalization":{"type":"boolean","description":"This is the apply text normalization of the eleven labs text to speech.","example":true,"default":false,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config.applyTextNormalization","typeLabel":"boolean"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0.config","typeLabel":"object"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.0","typeLabel":"Eleven Labs TTS · object"},{"type":"object","title":"Deepgram TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"deepgram","enum":["deepgram"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en-US","enum":["en-US","en-UK"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `aura-luna-en` for `Luna (US) Female` voice.","example":"aura-luna-en","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.1","typeLabel":"Deepgram TTS · object"},{"type":"object","title":"Microsoft TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"microsoft","enum":["microsoft"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en-US","enum":["en-US","es-ES","fr-FR","hi-In"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `en-US-JennyNeural` for `Jenny (Female)` voice.","example":"en-US-JennyNeural","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2.voice","typeLabel":"string"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.2","typeLabel":"Microsoft TTS · object"},{"type":"object","title":"Cartesia TTS","properties":{"enabled":{"description":"If you want to use multiple voices for multiple languages, you can add multiple tts configurations and set the `enabled` flag to true for only one of the desired tts configuration that will be used as main tts configuration. If the language of assistant is not present in the tts configuration, the `default` tts configuration will be used.","type":"boolean","default":true,"example":true,"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.enabled","typeLabel":"boolean"},"vendor":{"type":"string","example":"cartesia","enum":["cartesia"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.vendor","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language of the text to speech.","example":"en","enum":["en","es","fr","zh","hi"],"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","description":"Provider voice ID. Ex: Voice ID will be `79f8b5fb-2cc8-479a-80df-29f7a7cf1a3e` for `Nonfiction Man` voice.","example":"79f8b5fb-2cc8-479a-80df-29f7a7cf1a3e","uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3.voice","typeLabel":"string"}},"uniqueKey":"config.speech.ttsData.items.[INDEX].oneOf.3","typeLabel":"Cartesia TTS · object"}],"uniqueKey":"config.speech.ttsData.items.[INDEX]","typeLabel":"Eleven Labs TTS · object | Deepgram TTS · object | Microsoft TTS · object | Cartesia TTS · object"},"uniqueKey":"config.speech.ttsData","typeLabel":"(Eleven Labs TTS · object | Deepgram TTS · object | Microsoft TTS · object | Cartesia TTS · object)[]"}},"uniqueKey":"config.speech","typeLabel":"object"}},"uniqueKey":"config","typeLabel":"object"},"hints":{"type":"array","description":"Provide keyword hints to help the assistant better recognize and transcribe important words or phrases.","items":{"type":"string","uniqueKey":"hints.items.[INDEX]","typeLabel":"string"},"uniqueKey":"hints","typeLabel":"string[]"},"backgroundSound":{"oneOf":[{"type":"string","title":"Interactly Supported Sounds","description":"This is the background sound in the call. Default is 'disable'. You can also provide a custom sound by providing a URL to an audio file. URL should be publicly accessible and should starts with https:// only. \n\nNote: Currently custom sound is not supported in `twilio` phone vendor.","maxLength":1000,"enum":["enable","disable"],"example":"enable","uniqueKey":"backgroundSound.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Custom Sound URL","description":"This is the background sound in the call. Default is 'disable'. You can also provide a custom sound by providing a URL to an audio file. URL should be publicly accessible and should starts with https:// only. \n\nNote: Currently custom sound is not supported in `twilio` phone vendor.","format":"uri","maxLength":1000,"example":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","uniqueKey":"backgroundSound.oneOf.1","typeLabel":"string\u003curi>"}],"uniqueKey":"backgroundSound","typeLabel":"enum\u003cstring> | string\u003curi>"},"backgroundSoundVolume":{"type":"number","description":"This is the volume of the background sound. It is a number between 1 and 100.","default":50,"example":50,"uniqueKey":"backgroundSoundVolume","typeLabel":"number"},"ttsCacheEnabled":{"type":"boolean","description":"This is the enabled flag of the tts cache.","example":false,"uniqueKey":"ttsCacheEnabled","typeLabel":"boolean"},"ttsAudioCacheScope":{"type":"string","description":"This is the storage scope of the tts audio cache. It can be one of the following: 'assistant', 'team', 'global'. 'global' is deprecated and will be removed in future.","enum":["assistant","team","global"],"uniqueKey":"ttsAudioCacheScope","typeLabel":"enum\u003cstring>"},"maxConsecutiveTtsFailures":{"type":"integer","description":"Maximum number of consecutive TTS turn failures before the call is ended automatically.","default":2,"example":2,"minimum":0,"uniqueKey":"maxConsecutiveTtsFailures","typeLabel":"integer"},"recordingEnabled":{"type":"boolean","description":"Controls whether call recording is enabled for this assistant.","default":true,"example":true,"uniqueKey":"recordingEnabled","typeLabel":"boolean"},"recordAfterTransfer":{"type":"boolean","description":"When enabled, call recording continues after the call is forwarded or warm-transferred to another party.","default":false,"example":false,"uniqueKey":"recordAfterTransfer","typeLabel":"boolean"},"postCallTranscriptsEnabled":{"type":"boolean","description":"When enabled, a post-call transcript file is generated and stored alongside the call recording after the call ends.","default":false,"example":false,"uniqueKey":"postCallTranscriptsEnabled","typeLabel":"boolean"},"assistantBackchannelingEnabled":{"type":"boolean","description":"This is the backchanneling enabled of the assistant.","example":false,"uniqueKey":"assistantBackchannelingEnabled","typeLabel":"boolean"},"dtmfInputEnabled":{"type":"boolean","description":"This is a boolean that controls whether the DTMF input is enabled for the assistant.","example":false,"uniqueKey":"dtmfInputEnabled","typeLabel":"boolean"},"maxCallDuration":{"type":"integer","description":"This is the max call duration(in minutes) of the assistant.","example":900,"minimum":1,"maximum":120,"uniqueKey":"maxCallDuration","typeLabel":"integer"},"idleTimeout":{"type":"integer","description":"How long should the assistant wait in silence before confirming the user's presence and playing an idle message?","default":30,"example":20,"minimum":5,"maximum":600,"uniqueKey":"idleTimeout","typeLabel":"integer"},"maxIdleMessagesInSequence":{"type":"integer","description":"Maximum number of times to repeat the idle message in sequence","example":3,"minimum":1,"maximum":5,"uniqueKey":"maxIdleMessagesInSequence","typeLabel":"integer"},"startSpeakingOptions":{"type":"object","description":"Configuration for when the assistant should start talking.","properties":{"waitSeconds":{"type":"number","description":"Number of seconds to wait before starting to process speech","default":0,"uniqueKey":"startSpeakingOptions.waitSeconds","typeLabel":"number"},"smartEndpointing":{"type":"string","description":"Controls the endpointing strategy for detecting when a user has finished speaking","enum":["Interactly","Off","LiveKit"],"default":"Interactly","uniqueKey":"startSpeakingOptions.smartEndpointing","typeLabel":"enum\u003cstring>"},"onPunctuationSeconds":{"type":"number","description":"The minimum number of seconds to wait after transcription ending with punctuation before sending a request to the model. \n\nThis is only used if `smartEndpointing` is set to `Off`.","default":0,"uniqueKey":"startSpeakingOptions.onPunctuationSeconds","typeLabel":"number"},"onNoPunctuationSeconds":{"type":"number","description":"The minimum number of seconds to wait after transcription ending without punctuation before sending a request to the model. \n\nThis is only used if `smartEndpointing` is set to `Off`.","default":0,"uniqueKey":"startSpeakingOptions.onNoPunctuationSeconds","typeLabel":"number"},"onNumberSeconds":{"type":"number","description":"The minimum number of seconds to wait after transcription ending with a number before sending a request to the model. \n\nThis is only used if `smartEndpointing` is set to `Off`.","default":0,"uniqueKey":"startSpeakingOptions.onNumberSeconds","typeLabel":"number"},"LiveKitBaseValue":{"type":"number","description":"In the expression where X is the probability that the user is still speaking: \n`LiveKitBaseValue + (LiveKitScaleValue * X)`\n This is the base timeout value in milliseconds.\n\nThis is only used if `smartEndpointing` is set to `LiveKit`.","default":100,"uniqueKey":"startSpeakingOptions.LiveKitBaseValue","typeLabel":"number"},"LiveKitScaleValue":{"type":"number","description":"In the expression where X is the probability that the user is still speaking: \n`LiveKitBaseValue + (LiveKitScaleValue * X)`\n This is the scaling factor for LiveKit endpointing that adjusts based on speech probability.\n\nThis is only used if `smartEndpointing` is set to `LiveKit`.","default":1000,"uniqueKey":"startSpeakingOptions.LiveKitScaleValue","typeLabel":"number"}},"uniqueKey":"startSpeakingOptions","typeLabel":"object"},"stopSpeakingOptions":{"type":"object","description":"Configuration for detecting when when assistant should stop talking on customer interruption.","properties":{"numberOfWords":{"type":"number","description":"This is the number of words that the customer has to say before the assistant will stop talking.","default":3,"uniqueKey":"stopSpeakingOptions.numberOfWords","typeLabel":"number"},"voiceSeconds":{"type":"number","description":"This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking.","default":0,"uniqueKey":"stopSpeakingOptions.voiceSeconds","typeLabel":"number"}},"uniqueKey":"stopSpeakingOptions","typeLabel":"object"},"userInterruptionAckPlan":{"type":"object","description":"This is the plan to respond to early interruptions by user with polite filler phrases.","properties":{"enabled":{"type":"boolean","description":"This is the enabled flag of the user interruption ack plan.","uniqueKey":"userInterruptionAckPlan.enabled","typeLabel":"boolean"},"count":{"type":"number","description":"This is the number of times the user will interrupt the assistant before responding with a polite filler phrase.","default":2,"uniqueKey":"userInterruptionAckPlan.count","typeLabel":"number"},"words":{"type":"number","description":"This is the number of words that the user will interrupt the assistant","default":4,"uniqueKey":"userInterruptionAckPlan.words","typeLabel":"number"},"phrases":{"type":"array","description":"This is the list of phrases that the assistant will use to respond to the user's early interruptions.","items":{"type":"string","uniqueKey":"userInterruptionAckPlan.phrases.items.[INDEX]","typeLabel":"string"},"example":["Please hold on while I check your account.","one moment please","let me just check that for you"],"uniqueKey":"userInterruptionAckPlan.phrases","typeLabel":"string[]"}},"uniqueKey":"userInterruptionAckPlan","typeLabel":"object"},"assistantToolIds":{"type":"array","items":{"type":"string","uniqueKey":"assistantToolIds.items.[INDEX]","typeLabel":"string"},"description":"This is the list of tool IDs of the assistant.","example":[],"uniqueKey":"assistantToolIds","typeLabel":"string[]"},"assistantPredefinedTools":{"type":"object","description":"Enable or disable specific tools that the assistant can use to improve its functionality.","properties":{"knowledgeBase":{"type":"boolean","description":"This will allow the assistant to end the call from its side.","default":false,"uniqueKey":"assistantPredefinedTools.knowledgeBase","typeLabel":"boolean"},"endCall":{"type":"boolean","description":"This will allow the assistant to end the call from its side.","default":false,"uniqueKey":"assistantPredefinedTools.endCall","typeLabel":"boolean"},"appointment":{"type":"boolean","description":"This will allow the assistant to manage appointments, including scheduling, rescheduling, and cancellations.","default":false,"uniqueKey":"assistantPredefinedTools.appointment","typeLabel":"boolean"},"volumeControl":{"type":"boolean","description":"This will allow the assistant to adjust the call volume.","default":false,"uniqueKey":"assistantPredefinedTools.volumeControl","typeLabel":"boolean"},"waitList":{"type":"boolean","description":"This will allow the assistant to access the wait list.","default":false,"uniqueKey":"assistantPredefinedTools.waitList","typeLabel":"boolean"},"callForward":{"type":"boolean","description":"This will allow the assistant to forward calls to the desired recipient or queue.","default":false,"uniqueKey":"assistantPredefinedTools.callForward","typeLabel":"boolean"},"sendSms":{"type":"boolean","description":"This will allow the assistant to send SMS messages during the call.","default":false,"uniqueKey":"assistantPredefinedTools.sendSms","typeLabel":"boolean"}},"uniqueKey":"assistantPredefinedTools","typeLabel":"object"},"assistantType":{"type":"string","description":"This is the type of the assistant. It can be one of the following: 'single_prompt', 'workflow_based'.","enum":["single_prompt","workflow_based"],"default":"single_prompt","uniqueKey":"assistantType","typeLabel":"enum\u003cstring>"},"assistantKnowledgeBaseIds":{"type":"array","items":{"type":"string","uniqueKey":"assistantKnowledgeBaseIds.items.[INDEX]","typeLabel":"string"},"description":"This is the list of knowledge base IDs of the assistant. Provide only when `assistantPredefinedTools.knowledgeBase` is enabled","example":[],"uniqueKey":"assistantKnowledgeBaseIds","typeLabel":"string[]"},"endCallMessage":{"type":"string","description":"This is the message that the assistant will say if it ends the call. Provide only when `assistantPredefinedTools.endCall` is enabled","example":"Goodbye!","uniqueKey":"endCallMessage","typeLabel":"string"},"endCallToolDescription":{"type":"string","description":"This is the description of the tool that the assistant will use to end the call. Provide only when `assistantPredefinedTools.endCall` is enabled","example":"Trigger the end call only when the user is done with the conversation.","uniqueKey":"endCallToolDescription","typeLabel":"string"},"endCallPhrases":{"type":"array","description":"List of phrases that the assistant will listen to end the call. Provide only when `assistantPredefinedTools.endCall` is enabled","items":{"type":"string","uniqueKey":"endCallPhrases.items.[INDEX]","typeLabel":"string"},"example":["goodbye","bye"],"uniqueKey":"endCallPhrases","typeLabel":"string[]"},"callForwardData":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number used to forward the call.","example":"+1234567890","uniqueKey":"callForwardData.items.[INDEX].phoneNumber","typeLabel":"string"},"extension":{"type":"string","description":"This is the extension of the assistant. Leave it empty if there is no extension.","example":"","uniqueKey":"callForwardData.items.[INDEX].extension","typeLabel":"string"},"name":{"type":"string","description":"This is a friendly name for the call forward.","example":"call-forward-name","uniqueKey":"callForwardData.items.[INDEX].name","typeLabel":"string"},"onFailedMessage":{"type":"string","description":"This is the message that the assistant will say if the call forward fails.","example":"The call forward failed. Please try again later.","required":false,"uniqueKey":"callForwardData.items.[INDEX].onFailedMessage","typeLabel":"string"}},"uniqueKey":"callForwardData.items.[INDEX]","typeLabel":"object"},"description":"This is the call-forwarding data of the assistant.","example":{"phoneNumber":"+1234567890","extension":"","name":"call-forward-name"},"uniqueKey":"callForwardData","typeLabel":"object[]"},"warmTransferEnabled":{"type":"boolean","description":"Enables warm transfer when forwarding calls. The receiving agent is connected before the caller is transferred, allowing a briefing before handoff. Requires `assistantPredefinedTools.callForward` to be enabled.","default":false,"example":false,"uniqueKey":"warmTransferEnabled","typeLabel":"boolean"},"warmTransferConversational":{"type":"boolean","description":"When enabled with `warmTransferEnabled`, the assistant converses with the receiving agent before completing the transfer. When disabled, a pre-generated briefing message is played to the agent instead.","default":false,"example":false,"uniqueKey":"warmTransferConversational","typeLabel":"boolean"},"holdMusicUrl":{"type":"string","description":"URL of the hold music played to the caller while a conversational warm transfer is in progress. Must be a publicly accessible HTTPS URL.","default":"","example":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","uniqueKey":"holdMusicUrl","typeLabel":"string"},"warmTransferTimeout":{"type":"integer","description":"Maximum time in seconds to wait for the receiving agent to answer during a warm transfer before the transfer is considered failed.","default":300,"example":300,"minimum":1,"maximum":3600,"uniqueKey":"warmTransferTimeout","typeLabel":"integer"},"assistantAnalysis":{"type":"object","properties":{"summary":{"type":"object","description":"This is the plan for generating the summary of the call. This outputs to `call.analysis.summary`.","properties":{"enabled":{"type":"boolean","description":"This is a boolean that controls whether the summary is generated. If set to false, the model will not generate a summary of the call.\n\n@default false","example":false,"uniqueKey":"assistantAnalysis.summary.enabled","typeLabel":"boolean"},"prompt":{"type":"string","description":"This is the prompt that the model will use to generate the summary of the call.","example":"Generate a summary of the call.","uniqueKey":"assistantAnalysis.summary.prompt","typeLabel":"string"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty. \n Usage: \n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond. \n @default 5 seconds","minimum":1,"maximum":60,"example":30,"uniqueKey":"assistantAnalysis.summary.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"assistantAnalysis.summary","typeLabel":"object"},"successEvaluation":{"type":"object","description":"This is the plan for generating the success evaluation of the call. This outputs to `call.analysis.successEvaluation`.","properties":{"enabled":{"type":"boolean","description":"This is a boolean that controls whether the success evaluation is generated. If set to false, the model will not generate a success evaluation of the call.\n\n@default false","example":false,"uniqueKey":"assistantAnalysis.successEvaluation.enabled","typeLabel":"boolean"},"prompt":{"type":"string","description":"This is the prompt that the model will use to generate the success evaluation of the call.","example":"Evaluate the success of the call.","uniqueKey":"assistantAnalysis.successEvaluation.prompt","typeLabel":"string"},"rubric":{"type":"string","enum":["NumericScale","DescriptiveScale","Checklist","Matrix","PercentageScale","LikertScale","AutomaticRubric","PassFail"],"description":"This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`.\n\nOptions include:\n- 'NumericScale': A scale of 1 to 10.\n- 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.\n- 'Checklist': A checklist of criteria and their status.\n- 'Matrix': A grid that evaluates multiple criteria across different performance levels.\n- 'PercentageScale': A scale of 0% to 100%.\n- 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly Disagree.\n- 'AutomaticRubric': Automatically break down evaluation into several criteria, each with its own score.\n- 'PassFail': A simple 'true' if call passed, 'false' if not.\n\nDefault is 'PassFail'.","uniqueKey":"assistantAnalysis.successEvaluation.rubric","typeLabel":"enum\u003cstring>"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty. \n Usage: \n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond. \n @default 5 seconds","minimum":1,"maximum":60,"example":30,"uniqueKey":"assistantAnalysis.successEvaluation.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"assistantAnalysis.successEvaluation","typeLabel":"object"},"structuredData":{"type":"object","description":"This is the plan for generating the structured data from the call. This outputs to `call.analysis.structuredData`.","properties":{"enabled":{"type":"boolean","description":"This determines whether structured data is generated and stored in `call.analysis.structuredData`. Defaults to false.\n\nUsage:\n- If you want to extract structured data, set this to true and provide a `schema`.\n\n@default false","default":false,"uniqueKey":"assistantAnalysis.structuredData.enabled","typeLabel":"boolean"},"prompt":{"type":"string","description":"This is the prompt that the model will use to generate the structured data of the call.","example":"Extract structured data from the call.","uniqueKey":"assistantAnalysis.structuredData.prompt","typeLabel":"string"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.structuredData` will be empty.\n\nUsage:\n- To guarantee the structured data is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"example":30,"uniqueKey":"assistantAnalysis.structuredData.timeoutSeconds","typeLabel":"number"},"schema":{"type":"object","description":"This is the schema of the structured data. The output is stored in `call.analysis.structuredData`.\n\nComplete guide on JSON Schema can be found [here](https://ajv.js.org/json-schema.html#json-data-type).","required":["type"],"example":{"type":"object","properties":{"name":{"type":"string","description":"This is the name of the user.","example":"John Doe"},"dob":{"type":"string","format":"date","description":"This is the date of birth of the user.","example":"1990-03-08"}}},"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"assistantAnalysis.structuredData.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"assistantAnalysis.structuredData.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"assistantAnalysis.structuredData.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"assistantAnalysis.structuredData.schema.description","typeLabel":"string"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"assistantAnalysis.structuredData.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"assistantAnalysis.structuredData.schema.required","typeLabel":"string[]"}},"uniqueKey":"assistantAnalysis.structuredData.schema","typeLabel":"object"}},"uniqueKey":"assistantAnalysis.structuredData","typeLabel":"object"}},"uniqueKey":"assistantAnalysis","typeLabel":"object"},"assistantOverrides":{"type":"object","description":"This is where you can override the default behavior of the assistant.","properties":{"welcomeMessage":{"type":"string","description":"This is the message that the assistant will say when the call starts.","example":"Hello, how can I help you today?","uniqueKey":"assistantOverrides.welcomeMessage","typeLabel":"string"},"welcomeMessageMode":{"type":"string","description":"This is the mode of the welcome message. It can be one of the following: 'assistant-speaks-first', 'assistant-waits-for-user', 'automatic'.","example":"assistant-speaks-first","default":"automatic","uniqueKey":"assistantOverrides.welcomeMessageMode","typeLabel":"string"},"welcomeMessageInterruptionsEnabled":{"type":"boolean","description":"This is a boolean that controls whether the interruptions are enabled during the welcome message. If set to false, the user can not interrupt the welcome message.","example":false,"default":false,"uniqueKey":"assistantOverrides.welcomeMessageInterruptionsEnabled","typeLabel":"boolean"},"recordingEnabled":{"type":"boolean","description":"This is a boolean that controls whether the recording is enabled. If set to false, the model will not record the call.\n\n@default true","default":true,"example":true,"uniqueKey":"assistantOverrides.recordingEnabled","typeLabel":"boolean"},"recordAfterTransfer":{"type":"boolean","description":"When enabled, call recording continues after the call is forwarded or warm-transferred to another party.","default":false,"example":false,"uniqueKey":"assistantOverrides.recordAfterTransfer","typeLabel":"boolean"},"postCallTranscriptsEnabled":{"type":"boolean","description":"When enabled, a post-call transcript file is generated and stored alongside the call recording after the call ends.","default":false,"example":false,"uniqueKey":"assistantOverrides.postCallTranscriptsEnabled","typeLabel":"boolean"},"maxConsecutiveTtsFailures":{"type":"integer","description":"Maximum number of consecutive TTS turn failures before the call is ended automatically.","default":2,"example":2,"minimum":0,"uniqueKey":"assistantOverrides.maxConsecutiveTtsFailures","typeLabel":"integer"},"warmTransferEnabled":{"type":"boolean","description":"Enables warm transfer when forwarding calls. The receiving agent is connected before the caller is transferred.","default":false,"example":false,"uniqueKey":"assistantOverrides.warmTransferEnabled","typeLabel":"boolean"},"warmTransferConversational":{"type":"boolean","description":"When enabled with `warmTransferEnabled`, the assistant converses with the receiving agent via WebSocket before completing the transfer.","default":false,"example":false,"uniqueKey":"assistantOverrides.warmTransferConversational","typeLabel":"boolean"},"holdMusicUrl":{"type":"string","description":"URL of the hold music played to the caller while a conversational warm transfer is in progress.","default":"","example":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","uniqueKey":"assistantOverrides.holdMusicUrl","typeLabel":"string"},"warmTransferTimeout":{"type":"integer","description":"Maximum time in seconds to wait for the receiving agent to answer during a warm transfer.","default":300,"example":300,"minimum":1,"maximum":3600,"uniqueKey":"assistantOverrides.warmTransferTimeout","typeLabel":"integer"},"recordingPath":{"type":"string","description":"This is the path where the recording will be stored. If not provided, the recording will be stored in the default path.","example":"/recordings","uniqueKey":"assistantOverrides.recordingPath","typeLabel":"string"},"dynamicVariables":{"type":"object","description":"This is the dynamic variables of the conversation. Values in this object will be replaced in the assistant system prompt, welcome message, end call message. If your dynamic variable is `user_name`, you can use it in the system prompt message as `Hello, {{user_name}}`.","example":{"user_name":"John Doe"},"uniqueKey":"assistantOverrides.dynamicVariables","typeLabel":"object"}},"uniqueKey":"assistantOverrides","typeLabel":"object"},"assistantServer":{"type":"object","description":"This is where Interactly will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.","required":["url"],"properties":{"url":{"type":"string","description":"API endpoint to send requests to.","example":"https://api.example.com/v1/getUserDetails","isRequired":true,"uniqueKey":"assistantServer.url","typeLabel":"string"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request to your server. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":120,"example":20,"uniqueKey":"assistantServer.timeoutSeconds","typeLabel":"number"},"secret":{"type":"string","description":"This is the secret you can set that Interactly will send with every request to your server. Will be sent as a header called x-interactly-secret.","example":"my-secret","uniqueKey":"assistantServer.secret","typeLabel":"string"},"headers":{"type":"object","description":"These are the custom headers to include in the request sent to your server.\n\nEach key-value pair represents a header name and its value.","example":{},"uniqueKey":"assistantServer.headers","typeLabel":"object"},"enabled":{"type":"boolean","description":"This is a boolean that controls whether the server is enabled. If set to false, the model will not send webhooks to the server.\n\n@default false","example":false,"uniqueKey":"assistantServer.enabled","typeLabel":"boolean"},"messages":{"type":"array","enum":["status-update","conversation-update","hang","end-of-call-report","error"],"example":["status-update","conversation-update","hang","end-of-call-report","error"],"description":"These are the messages that will be sent to your Server URL.","items":{"type":"string","enum":["status-update","conversation-update","hang","end-of-call-report","error"],"uniqueKey":"assistantServer.messages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"assistantServer.messages","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"assistantServer","typeLabel":"object"},"assistantOutcome":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the outcome.","uniqueKey":"assistantOutcome.items.[INDEX].type","typeLabel":"string"},"field":{"type":"string","description":"This is the field of the outcome.","uniqueKey":"assistantOutcome.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"assistantOutcome.items.[INDEX]","typeLabel":"object"},"uniqueKey":"assistantOutcome","typeLabel":"object[]"},"smsConfiguration":{"type":"object","description":"Control how the assistant composes outbound SMS.","properties":{"enabled":{"type":"boolean","description":"This is the enabled flag of the sms configuration.","uniqueKey":"smsConfiguration.enabled","typeLabel":"boolean"},"sameAsAssistant":{"type":"boolean","description":"Use the same prompt as the assistant, or provide a custom SMS prompt.","uniqueKey":"smsConfiguration.sameAsAssistant","typeLabel":"boolean"},"smsPrompt":{"type":"string","description":"This is the sms prompt for handling sms responses.","uniqueKey":"smsConfiguration.smsPrompt","typeLabel":"string"}},"uniqueKey":"smsConfiguration","typeLabel":"object"},"persistHistory":{"type":"object","description":"Remember users and keep conversation history for follow-ups.","properties":{"enabled":{"type":"boolean","description":"This is the enabled flag of the persist history.","uniqueKey":"persistHistory.enabled","typeLabel":"boolean"},"call":{"type":"boolean","description":"Store metadata and transcripts of calls in persisted data for future personalization and context.","uniqueKey":"persistHistory.call","typeLabel":"boolean"},"sms":{"type":"boolean","description":"Keep outbound and inbound SMS content so follow-ups can reference earlier messages.","uniqueKey":"persistHistory.sms","typeLabel":"boolean"},"retentionPeriod":{"type":"number","description":"This is, how long(in number of days) to retain persisted data. Set to 0 to keep nothing.","example":7,"uniqueKey":"persistHistory.retentionPeriod","typeLabel":"number"}},"uniqueKey":"persistHistory","typeLabel":"object"},"_id":{"type":"string","description":"This is the unique identifier of the assistant.","example":"5f7b1b1b1b1b1b1b1b1b1b1b","uniqueKey":"_id","typeLabel":"string"},"teamId":{"type":"string","description":"This is the unique identifier of the team that the assistant belongs to.","example":"1f7b1b1b1b1b1b1b1b1b1b1b","uniqueKey":"teamId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"This is the ISO 8601 date-time string of when the record was created.","example":"2020-10-05T00:00:00.000Z","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"This is the ISO 8601 date-time string of when the record was last updated.","example":"2020-10-05T00:00:00.000Z","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"My Assistant","welcomeMessage":"Hello! How can I help you?","welcomeMessageMode":"assistant-speaks-first","welcomeMessageInterruptionsEnabled":false,"assistantProvider":"openai","assistantModel":"gpt-4o-mini","assistantLLMUrl":"\u003cstring>","assistantSystemPrompt":"You are AI assistant to help patients with their health care needs.","assistantTemperature":0,"assistantMaxTokens":256,"assistantResponseSplitter":",","config":{"speech":{"stt":{"vendor":"microsoft","languages":"en-US"},"sttFallback":{"enabled":true,"vendor":"microsoft","languages":"en-US"},"ttsData":[{"enabled":true,"vendor":"eleven-labs","language":"en-US","voice":"ZeK6O9RfGNGj0cJT2HoJ","config":{"modelId":"eleven_multilingual_v2","stability":0.7,"similarityBoost":0.85,"speakerBoost":true,"styleExaggeration":0.5,"seed":42,"speed":1,"applyTextNormalization":true}}]}},"hints":["\u003cstring>"],"backgroundSound":"enable","backgroundSoundVolume":50,"ttsCacheEnabled":false,"ttsAudioCacheScope":"assistant","maxConsecutiveTtsFailures":2,"recordingEnabled":true,"recordAfterTransfer":false,"postCallTranscriptsEnabled":false,"assistantBackchannelingEnabled":false,"dtmfInputEnabled":false,"maxCallDuration":900,"idleTimeout":20,"maxIdleMessagesInSequence":3,"startSpeakingOptions":{"waitSeconds":0,"smartEndpointing":"Interactly","onPunctuationSeconds":0,"onNoPunctuationSeconds":0,"onNumberSeconds":0,"LiveKitBaseValue":100,"LiveKitScaleValue":1000},"stopSpeakingOptions":{"numberOfWords":3,"voiceSeconds":0},"userInterruptionAckPlan":{"enabled":true,"count":2,"words":4,"phrases":["Please hold on while I check your account.","one moment please","let me just check that for you"]},"assistantToolIds":[],"assistantPredefinedTools":{"knowledgeBase":false,"endCall":false,"appointment":false,"volumeControl":false,"waitList":false,"callForward":false,"sendSms":false},"assistantType":"single_prompt","assistantKnowledgeBaseIds":[],"endCallMessage":"Goodbye!","endCallToolDescription":"Trigger the end call only when the user is done with the conversation.","endCallPhrases":["goodbye","bye"],"callForwardData":{"phoneNumber":"+1234567890","extension":"","name":"call-forward-name"},"warmTransferEnabled":false,"warmTransferConversational":false,"holdMusicUrl":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","warmTransferTimeout":300,"assistantAnalysis":{"summary":{"enabled":false,"prompt":"Generate a summary of the call.","timeoutSeconds":30},"successEvaluation":{"enabled":false,"prompt":"Evaluate the success of the call.","rubric":"NumericScale","timeoutSeconds":30},"structuredData":{"enabled":false,"prompt":"Extract structured data from the call.","timeoutSeconds":30,"schema":{"type":"object","properties":{"name":{"type":"string","description":"This is the name of the user.","example":"John Doe"},"dob":{"type":"string","format":"date","description":"This is the date of birth of the user.","example":"1990-03-08"}}}}},"assistantOverrides":{"welcomeMessage":"Hello, how can I help you today?","welcomeMessageMode":"assistant-speaks-first","welcomeMessageInterruptionsEnabled":false,"recordingEnabled":true,"recordAfterTransfer":false,"postCallTranscriptsEnabled":false,"maxConsecutiveTtsFailures":2,"warmTransferEnabled":false,"warmTransferConversational":false,"holdMusicUrl":"https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3","warmTransferTimeout":300,"recordingPath":"/recordings","dynamicVariables":{"user_name":"John Doe"}},"assistantServer":{"url":"https://api.example.com/v1/getUserDetails","timeoutSeconds":20,"secret":"my-secret","headers":{},"enabled":false,"messages":["status-update","conversation-update","hang","end-of-call-report","error"]},"assistantOutcome":[{"type":"\u003cstring>","field":"\u003cstring>"}],"smsConfiguration":{"enabled":true,"sameAsAssistant":true,"smsPrompt":"\u003cstring>"},"persistHistory":{"enabled":true,"call":true,"sms":true,"retentionPeriod":7},"_id":"5f7b1b1b1b1b1b1b1b1b1b1b","teamId":"1f7b1b1b1b1b1b1b1b1b1b1b","createdAt":"2020-10-05T00:00:00.000Z","updatedAt":"2020-10-05T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c0ae5dd7-6f42-4a17-87c1-f3d5b8b59c99":{"bearer":{"scheme":"bearer","bearerFormat":"Bearer","type":"http","description":"Retrieve your API Key from [Dashboard API Keys Section](https://dashboard.interactly.ai/api-keys).","scopes":[]}}},"servers":{"27fea4b5-1d76-431c-af58-12eeb003b876":{"url":"https://api-prod.interactly.ai","description":"API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"Bearer","type":"http","description":"Retrieve your API Key from [Dashboard API Keys Section](https://dashboard.interactly.ai/api-keys).","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Retrieve your API Key from [Dashboard API Keys Section](https://dashboard.interactly.ai/api-keys).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"https://api-prod.interactly.ai/api-docs/common/api.json"},"subdomain":"interactly","siteName":"Interactly API","title":"Update Assistant - Interactly API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-13T05:36:53.280Z","originalFileLocation":"api-reference/assistants/update-assistant.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=\"light\"}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=\"Update Assistant Details by ID\">\u003cmeta data-mint-head name=\"application-name\" content=\"Interactly API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_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/interactly/g50ZSunBarE7sRBb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Assistant - Interactly API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update Assistant Details by ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Interactly API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.interactly.ai/api-reference/assistants/update-assistant\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://interactly.mintlify.site/_mintlify/api/og/v2?division=Assistants\u0026amp;title=Update+Assistant\u0026amp;description=Update+Assistant+Details+by+ID\u0026amp;theme=d931c30529a0b21b8d46d56c\u0026amp;signature=76d9b7e3d33ec2e0144291b0110f96d792b28f8153632f1f7be29b1e860cc31c\">\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 Assistant - Interactly API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update Assistant Details by ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://interactly.mintlify.site/_mintlify/api/og/v2?division=Assistants\u0026amp;title=Update+Assistant\u0026amp;description=Update+Assistant+Details+by+ID\u0026amp;theme=d931c30529a0b21b8d46d56c\u0026amp;signature=76d9b7e3d33ec2e0144291b0110f96d792b28f8153632f1f7be29b1e860cc31c\">\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/interactly/g50ZSunBarE7sRBb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Interactly API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1E6EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.interactly.ai/api-reference/assistants/update-assistant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/assistants/update-assistant.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.interactly.ai/#organization\",\"name\":\"Interactly API\",\"url\":\"https://docs.interactly.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/interactly/ptkIknAxuLhZ0nuk/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=ptkIknAxuLhZ0nuk\u0026q=85\u0026s=1699fd93557b1619c6e3f1d2178e1a98\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.interactly.ai#website\",\"name\":\"Interactly API\",\"url\":\"https://docs.interactly.ai\",\"publisher\":{\"@id\":\"https://docs.interactly.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant#webpage\",\"url\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant\",\"name\":\"Update Assistant\",\"description\":\"Update Assistant Details by ID\",\"dateModified\":\"2026-07-13T05:36:53.280Z\",\"isPartOf\":{\"@id\":\"https://docs.interactly.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.interactly.ai/api-reference/calls/list-calls\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Assistants\",\"item\":\"https://docs.interactly.ai/api-reference/assistants/list-assistants\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update Assistant\",\"item\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant#apireference\",\"headline\":\"Update Assistant\",\"name\":\"Update Assistant\",\"description\":\"Update Assistant Details by ID\",\"url\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.interactly.ai/api-reference/assistants/update-assistant#webpage\"},\"dateModified\":\"2026-07-13T05:36:53.280Z\",\"publisher\":{\"@id\":\"https://docs.interactly.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.interactly.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Interactly API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Interactly API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/assistants/update-assistant.md","siteName":"Interactly API","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/welcome","groups":[]}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/general/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Keys","href":"/api-reference/api-keys"}]},{"group":"APIs","pages":[{"group":"Calls","pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /calls/v1/conversations","href":"/api-reference/calls/list-calls"},{"title":"Create Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /calls/v1/conversations","href":"/api-reference/calls/create-call"},{"title":"Connect Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /calls/v1/conversations/connect","href":"/api-reference/calls/connect-call"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /calls/v1/conversations/{id}","href":"/api-reference/calls/get-call"},{"title":"Control Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /calls/v1/conversations/{id}/control","href":"/api-reference/calls/control-call"}]},{"group":"Assistants","pages":[{"title":"List Assistants","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /assistants/v1/assistants","href":"/api-reference/assistants/list-assistants"},{"title":"Create Assistant","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /assistants/v1/assistants","href":"/api-reference/assistants/create-assistant"},{"title":"Get Assistant","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /assistants/v1/assistants/{id}","href":"/api-reference/assistants/get-assistant"},{"title":"Delete Assistant","description":"Delete Assistant by ID","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json delete /assistants/v1/assistants/{id}","href":"/api-reference/assistants/delete-assistant"},{"title":"Update Assistant","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json patch /assistants/v1/assistants/{id}","href":"/api-reference/assistants/update-assistant"}]},{"group":"Phone Numbers","pages":[{"title":"List Purchasable Numbers","description":"Retrieves a list of numbers available for purchase.","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /assistants/v1/numbers/purchase-list","href":"/api-reference/phone-numbers/list-purchasable-numbers"},{"title":"Import Number","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /assistants/v1/numbers/{provider}","href":"/api-reference/phone-numbers/import-number"},{"title":"Purchase Number","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /assistants/v1/numbers/purchase","href":"/api-reference/phone-numbers/purchase-number"},{"title":"List Numbers","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /assistants/v1/numbers","href":"/api-reference/phone-numbers/list-numbers"},{"title":"Update Number","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json put /assistants/v1/numbers/{id}","href":"/api-reference/phone-numbers/update-number"},{"title":"Delete Number","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json delete /assistants/v1/numbers/{id}","href":"/api-reference/phone-numbers/delete-number"}]},{"group":"Tools","pages":[{"title":"List Tools","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /assistants/v1/tools","href":"/api-reference/tools/list-tools"},{"title":"Create Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /assistants/v1/tools","href":"/api-reference/tools/create-tool"},{"title":"Get Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /assistants/v1/tools/{id}","href":"/api-reference/tools/get-tool"},{"title":"Delete Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json delete /assistants/v1/tools/{id}","href":"/api-reference/tools/delete-tool"},{"title":"Update Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json patch /assistants/v1/tools/{id}","href":"/api-reference/tools/update-tool"}]},{"group":"Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /kb/v1/files","href":"/api-reference/files/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /kb/v1/files","href":"/api-reference/files/upload-file"},{"title":"Get File","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /kb/v1/files/{id}","href":"/api-reference/files/get-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json delete /kb/v1/files/{id}","href":"/api-reference/files/delete-file"}]},{"group":"Knowledge Bases","pages":[{"title":"List Knowledge Bases","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Create Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json put /kb/v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json delete /kb/v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Get Knowledge Base Status","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases/{id}/status","href":"/api-reference/knowledge-bases/get-knowledge-base-status"},{"title":"Query Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases/{id}/query","href":"/api-reference/knowledge-bases/query-knowledge-base"},{"title":"Train Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases/{id}/train","href":"/api-reference/knowledge-bases/train-knowledge-base"},{"title":"Fetch the FAQ template for a knowledge base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases/{id}/faq-template","href":"/api-reference/knowledge-bases/fetch-the-faq-template-for-a-knowledge-base"},{"title":"Update questions and answers in FAQ template for a knowledge base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json put /kb/v1/knowledge-bases/{id}/faq-template","href":"/api-reference/knowledge-bases/update-questions-and-answers-in-faq-template-for-a-knowledge-base"},{"title":"Insert new questions and answers into FAQ template for a knowledge base","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases/{id}/faq-template","href":"/api-reference/knowledge-bases/insert-new-questions-and-answers-into-faq-template-for-a-knowledge-base"},{"title":"Remove questions from FAQ","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json delete /kb/v1/knowledge-bases/{id}/faq-template/questions","href":"/api-reference/knowledge-bases/remove-questions-from-faq"}]},{"group":"Webhooks","pages":[{"title":"Server Message","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/common/api.json post /server","href":"/api-reference/webhooks/server-message"}]}]},{"group":"Campaigns","pages":[{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns","href":"/api-reference/campaigns/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns","href":"/api-reference/campaigns/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/campaigns/get-campaign"},{"title":"Delete Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json delete /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/campaigns/delete-campaign"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json patch /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/campaigns/update-campaign"},{"title":"Campaign Action","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/action","href":"/api-reference/campaigns/campaigns/campaign-action"},{"title":"Clone Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/clone","href":"/api-reference/campaigns/campaigns/clone-campaign"},{"title":"Restore Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/restore","href":"/api-reference/campaigns/campaigns/restore-campaign"}]},{"group":"Campaigns Calls","pages":[{"title":"Upload Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/calls","href":"/api-reference/campaigns/campaigns-calls/upload-calls"},{"title":"Get Call Count","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/count","href":"/api-reference/campaigns/campaigns-calls/get-call-count"},{"title":"List Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/list","href":"/api-reference/campaigns/campaigns-calls/list-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/campaigns/campaigns-calls/get-call"},{"title":"Delete Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json delete /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/campaigns/campaigns-calls/delete-call"},{"title":"Update Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json patch /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/campaigns/campaigns-calls/update-call"},{"title":"Restore Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}/restore","href":"/api-reference/campaigns/campaigns-calls/restore-call"},{"title":"Download Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{config_id}/calls/download","href":"/api-reference/campaigns/campaigns-calls/download-calls"},{"title":"Send Campaign Report Email","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{config_id}/calls/report","href":"/api-reference/campaigns/campaigns-calls/send-campaign-report-email"}]},{"group":"Campaign Bulk Calls","pages":[{"title":"Create Campaign Calls Bulk","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/schedule/calls","href":"/api-reference/campaigns/campaign-bulk-calls/create-campaign-calls-bulk"},{"title":"Get Call Status by ID","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/insurance-calling/calls/{call_id}/status","href":"/api-reference/campaigns/campaign-bulk-calls/get-call-status-by-id"},{"title":"Bulk Call Status","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/insurance-calling/calls/status","href":"/api-reference/campaigns/campaign-bulk-calls/bulk-call-status"}]},{"group":"Campaign Stats","pages":[{"title":"Campaign Call Stats","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/stats/campaigns/calls","href":"/api-reference/campaigns/campaign-stats/campaign-call-stats"},{"title":"Campaign Tags","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/stats/campaigns/tags","href":"/api-reference/campaigns/campaign-stats/campaign-tags"},{"title":"Campaign Stats","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/stats/campaigns","href":"/api-reference/campaigns/campaign-stats/campaign-stats"}]},{"group":"Contacts","pages":[{"title":"Get Contacts","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/contacts","href":"/api-reference/campaigns/contacts/get-contacts"},{"title":"Create New Contact","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/contacts","href":"/api-reference/campaigns/contacts/create-new-contact"},{"title":"Get Contacts Stats","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/contacts/stats","href":"/api-reference/campaigns/contacts/get-contacts-stats"},{"title":"Get Contact By Id","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/contacts/{contact_id}","href":"/api-reference/campaigns/contacts/get-contact-by-id"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json put /campaigns/v1/contacts/{contact_id}","href":"/api-reference/campaigns/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/campaigns/api.json delete /campaigns/v1/contacts/{contact_id}","href":"/api-reference/campaigns/contacts/delete-contact"}]}]},{"group":"Workflows","pages":[{"group":"Nodes","pages":[{"title":"Get Node Types","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes/types","href":"/api-reference/workflows/nodes/get-node-types"},{"title":"Get Node Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes/schema/{node_type}","href":"/api-reference/workflows/nodes/get-node-schema"},{"title":"Get Nodes","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes","href":"/api-reference/workflows/nodes/get-nodes"},{"title":"Create Node","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/nodes","href":"/api-reference/workflows/nodes/create-node"},{"title":"Get Node","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes/{node_id}","href":"/api-reference/workflows/nodes/get-node"},{"title":"Delete Node","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/nodes/{node_id}","href":"/api-reference/workflows/nodes/delete-node"},{"title":"Update Node","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/nodes/{node_id}","href":"/api-reference/workflows/nodes/update-node"}]},{"group":"Edges","pages":[{"title":"Get Edge Types","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges/types","href":"/api-reference/workflows/edges/get-edge-types"},{"title":"Get Edge Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges/schema/{edge_type}","href":"/api-reference/workflows/edges/get-edge-schema"},{"title":"Get Edges","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges","href":"/api-reference/workflows/edges/get-edges"},{"title":"Create Edge","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/edges","href":"/api-reference/workflows/edges/create-edge"},{"title":"Get Edge","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges/{edge_id}","href":"/api-reference/workflows/edges/get-edge"},{"title":"Delete Edge","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/edges/{edge_id}","href":"/api-reference/workflows/edges/delete-edge"},{"title":"Update Edge","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/edges/{edge_id}","href":"/api-reference/workflows/edges/update-edge"}]},{"group":"Workflows","pages":[{"title":"Get Workflow Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/schema","href":"/api-reference/workflows/workflows/get-workflow-schema"},{"title":"Get Global Node Config Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/schemas/global-node-config","href":"/api-reference/workflows/workflows/get-global-node-config-schema"},{"title":"Get Workflow Dynamic Variables","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/dynamic-variables/{workflow_id}","href":"/api-reference/workflows/workflows/get-workflow-dynamic-variables"},{"title":"Get Workflows","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows","href":"/api-reference/workflows/workflows/get-workflows"},{"title":"Create Workflow","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows","href":"/api-reference/workflows/workflows/create-workflow"},{"title":"Clone Workflow Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/clone","href":"/api-reference/workflows/workflows/clone-workflow-endpoint"},{"title":"Get Workflow","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}","href":"/api-reference/workflows/workflows/get-workflow"},{"title":"Delete Workflow","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}","href":"/api-reference/workflows/workflows/delete-workflow"},{"title":"Update Workflow","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}","href":"/api-reference/workflows/workflows/update-workflow"},{"title":"Update Workflow Concurrency","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}/concurrency","href":"/api-reference/workflows/workflows/update-workflow-concurrency"},{"title":"Export Workflow Bundle","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/export","href":"/api-reference/workflows/workflows/export-workflow-bundle"},{"title":"Import Workflow Bundle Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/import/bundle","href":"/api-reference/workflows/workflows/import-workflow-bundle-endpoint"}]},{"group":"Workflow Versions","pages":[{"title":"List Team Active Versions","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/versions/active","href":"/api-reference/workflows/workflow-versions/list-team-active-versions"},{"title":"List Workflow Versions","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/versions","href":"/api-reference/workflows/workflow-versions/list-workflow-versions"},{"title":"Create Workflow Version","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/versions","href":"/api-reference/workflows/workflow-versions/create-workflow-version"},{"title":"Set Active Workflow Version","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/versions/{version_number}/activate","href":"/api-reference/workflows/workflow-versions/set-active-workflow-version"},{"title":"Delete Workflow Version","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}/versions/{version_number}","href":"/api-reference/workflows/workflow-versions/delete-workflow-version"},{"title":"Update Workflow Version Name","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}/versions/{version_number}","href":"/api-reference/workflows/workflow-versions/update-workflow-version-name"},{"title":"Update Workflow Version Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}/versions/{version_number}/config","href":"/api-reference/workflows/workflow-versions/update-workflow-version-config"},{"title":"Compare Workflow Versions","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/versions/{version1_number}/diff/{version2_number}","href":"/api-reference/workflows/workflow-versions/compare-workflow-versions"}]},{"group":"Workflow Favorites","pages":[{"title":"Mark Workflow Favorite","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/favorite","href":"/api-reference/workflows/workflow-favorites/mark-workflow-favorite"},{"title":"Unmark Workflow Favorite","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}/favorite","href":"/api-reference/workflows/workflow-favorites/unmark-workflow-favorite"}]},{"group":"Workflow Categories","pages":[{"title":"Get Workflow Categories","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-categories","href":"/api-reference/workflows/workflow-categories/get-workflow-categories"}]},{"group":"Tools","pages":[{"title":"Get Tool Types","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/types","href":"/api-reference/workflows/tools/get-tool-types"},{"title":"Get Tool Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/schema/{tool_type}","href":"/api-reference/workflows/tools/get-tool-schema"},{"title":"Get Configurable Inbuilt Tools","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/configurable-inbuilt","href":"/api-reference/workflows/tools/get-configurable-inbuilt-tools"},{"title":"Get Configurable Inbuilt Tool Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/configurable-inbuilt/{key}","href":"/api-reference/workflows/tools/get-configurable-inbuilt-tool-schema"},{"title":"Get Inbuilt Tools","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/inbuilt","href":"/api-reference/workflows/tools/get-inbuilt-tools"},{"title":"Get Tools","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools","href":"/api-reference/workflows/tools/get-tools"},{"title":"Create Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/tools","href":"/api-reference/workflows/tools/create-tool"},{"title":"Get Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/{tool_id}","href":"/api-reference/workflows/tools/get-tool"},{"title":"Delete Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/tools/{tool_id}","href":"/api-reference/workflows/tools/delete-tool"},{"title":"Update Tool","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/tools/{tool_id}","href":"/api-reference/workflows/tools/update-tool"}]},{"group":"LLM Configs","pages":[{"title":"Get Llm Config Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/schemas/llm-config","href":"/api-reference/workflows/llm-configs/get-llm-config-schema"},{"title":"Get Llm Configs","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/llm-configs","href":"/api-reference/workflows/llm-configs/get-llm-configs"},{"title":"Create Llm Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/llm-configs","href":"/api-reference/workflows/llm-configs/create-llm-config"},{"title":"Get Default Llm Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/llm-configs/default","href":"/api-reference/workflows/llm-configs/get-default-llm-config"},{"title":"Get Llm Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/llm-configs/{llm_config_id}","href":"/api-reference/workflows/llm-configs/get-llm-config"},{"title":"Delete Llm Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/llm-configs/{llm_config_id}","href":"/api-reference/workflows/llm-configs/delete-llm-config"},{"title":"Update Llm Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/llm-configs/{llm_config_id}","href":"/api-reference/workflows/llm-configs/update-llm-config"},{"title":"Test Llm Config","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/llm-configs/{llm_config_id}/test","href":"/api-reference/workflows/llm-configs/test-llm-config"},{"title":"Test Llm Config Inline","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/llm-configs/test","href":"/api-reference/workflows/llm-configs/test-llm-config-inline"}]},{"group":"Global Variables","pages":[{"title":"List Global Variables Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/global-variables","href":"/api-reference/workflows/global-variables/list-global-variables-endpoint"},{"title":"Create Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/global-variables","href":"/api-reference/workflows/global-variables/create-global-variable-endpoint"},{"title":"Resolve Global Variables Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/global-variables/resolve","href":"/api-reference/workflows/global-variables/resolve-global-variables-endpoint"},{"title":"Get Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/global-variables/{variable_id}","href":"/api-reference/workflows/global-variables/get-global-variable-endpoint"},{"title":"Delete Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/global-variables/{variable_id}","href":"/api-reference/workflows/global-variables/delete-global-variable-endpoint"},{"title":"Update Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/global-variables/{variable_id}","href":"/api-reference/workflows/global-variables/update-global-variable-endpoint"},{"title":"Bulk Create Global Variables Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/global-variables/bulk","href":"/api-reference/workflows/global-variables/bulk-create-global-variables-endpoint"}]},{"group":"Super Nodes","pages":[{"title":"List Super Nodes","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/super-nodes","href":"/api-reference/workflows/super-nodes/list-super-nodes"},{"title":"Get Super Node Interface","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/super-nodes/{workflow_id}","href":"/api-reference/workflows/super-nodes/get-super-node-interface"},{"title":"Get Super Node Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/super-nodes/{workflow_id}/schema","href":"/api-reference/workflows/super-nodes/get-super-node-schema"},{"title":"Publish As Super Node","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json put /workflows/v1/workflows/{workflow_id}/super-node-interface","href":"/api-reference/workflows/super-nodes/publish-as-super-node"},{"title":"Unpublish Super Node","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}/super-node-interface","href":"/api-reference/workflows/super-nodes/unpublish-super-node"},{"title":"Get Super Node Dependents","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/super-node-dependents","href":"/api-reference/workflows/super-nodes/get-super-node-dependents"},{"title":"Get Super Node Snapshot Status","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/super-node-snapshot-status","href":"/api-reference/workflows/super-nodes/get-super-node-snapshot-status"},{"title":"Expand Preview","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/expand-preview","href":"/api-reference/workflows/super-nodes/expand-preview"}]},{"group":"Workflow Runs","pages":[{"title":"Get Workflow Run Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs/schema","href":"/api-reference/workflows/workflow-runs/get-workflow-run-schema"},{"title":"Get Workflow Runs","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs","href":"/api-reference/workflows/workflow-runs/get-workflow-runs"},{"title":"Get Workflow Run","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs/{workflow_run_id}","href":"/api-reference/workflows/workflow-runs/get-workflow-run"},{"title":"Delete Workflow Run","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-runs/{workflow_run_id}","href":"/api-reference/workflows/workflow-runs/delete-workflow-run"},{"title":"Get Workflow Run Evaluation Result","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs/{workflow_run_id}/evaluation-result","href":"/api-reference/workflows/workflow-runs/get-workflow-run-evaluation-result"},{"title":"Add Comment To Workflow Run","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-runs/{workflow_run_id}/comments","href":"/api-reference/workflows/workflow-runs/add-comment-to-workflow-run"},{"title":"Add Comment To Workflow Run Event","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-runs/{workflow_run_id}/events/{event_logical_id}/comments","href":"/api-reference/workflows/workflow-runs/add-comment-to-workflow-run-event"},{"title":"Delete Workflow Run Comment","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-runs/{workflow_run_id}/comments/{comment_logical_id}","href":"/api-reference/workflows/workflow-runs/delete-workflow-run-comment"},{"title":"Delete Workflow Run Event Comment","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-runs/{workflow_run_id}/events/{event_logical_id}/comments/{comment_logical_id}","href":"/api-reference/workflows/workflow-runs/delete-workflow-run-event-comment"}]},{"group":"Workflow Execution","pages":[{"title":"Execute Workflow","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/execute","href":"/api-reference/workflows/workflow-execution/execute-workflow"},{"title":"Execute Checkpoint Run","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/runs/{workflow_run_id}/checkpoint-run","href":"/api-reference/workflows/workflow-execution/execute-checkpoint-run"}]},{"group":"Workflow Webhooks","pages":[{"title":"List Workflow Webhooks","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-webhooks","href":"/api-reference/workflows/workflow-webhooks/list-workflow-webhooks"},{"title":"Create Workflow Webhook","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-webhooks","href":"/api-reference/workflows/workflow-webhooks/create-workflow-webhook"},{"title":"Delete Workflow Webhook","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-webhooks/{webhook_id}","href":"/api-reference/workflows/workflow-webhooks/delete-workflow-webhook"},{"title":"Update Workflow Webhook","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflow-webhooks/{webhook_id}","href":"/api-reference/workflows/workflow-webhooks/update-workflow-webhook"},{"title":"List Workflow Webhook Events","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-webhooks/events","href":"/api-reference/workflows/workflow-webhooks/list-workflow-webhook-events"},{"title":"List Workflow Webhook Attempts","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-webhooks/events/{event_id}/attempts","href":"/api-reference/workflows/workflow-webhooks/list-workflow-webhook-attempts"},{"title":"Retry Workflow Webhook Event","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-webhooks/events/{event_doc_id}/retry","href":"/api-reference/workflows/workflow-webhooks/retry-workflow-webhook-event"}]},{"group":"Workflow Schedules","pages":[{"title":"List Workflow Schedules","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/schedules","href":"/api-reference/workflows/workflow-schedules/list-workflow-schedules"},{"title":"Create Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/schedules","href":"/api-reference/workflows/workflow-schedules/create-workflow-schedule"},{"title":"List Team Workflow Schedules","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-schedules","href":"/api-reference/workflows/workflow-schedules/list-team-workflow-schedules"},{"title":"Get Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-schedules/{schedule_id}","href":"/api-reference/workflows/workflow-schedules/get-workflow-schedule"},{"title":"Cancel Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-schedules/{schedule_id}","href":"/api-reference/workflows/workflow-schedules/cancel-workflow-schedule"},{"title":"Update Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflow-schedules/{schedule_id}","href":"/api-reference/workflows/workflow-schedules/update-workflow-schedule"}]},{"group":"Node Libraries","pages":[{"title":"Get Node Library Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/node-libraries/schema","href":"/api-reference/workflows/node-libraries/get-node-library-schema"},{"title":"Get Node Libraries","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/node-libraries","href":"/api-reference/workflows/node-libraries/get-node-libraries"},{"title":"Create Node Library","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/node-libraries","href":"/api-reference/workflows/node-libraries/create-node-library"},{"title":"Get Node Library","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/node-libraries/{node_library_id}","href":"/api-reference/workflows/node-libraries/get-node-library"},{"title":"Delete Node Library","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/node-libraries/{node_library_id}","href":"/api-reference/workflows/node-libraries/delete-node-library"},{"title":"Update Node Library","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/node-libraries/{node_library_id}","href":"/api-reference/workflows/node-libraries/update-node-library"}]},{"group":"Workflow Templates","pages":[{"title":"Get Workflow Template Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/templates/schema","href":"/api-reference/workflows/workflow-templates/get-workflow-template-schema"},{"title":"Get Workflow Templates","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/templates","href":"/api-reference/workflows/workflow-templates/get-workflow-templates"},{"title":"Create Workflow Template","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/templates","href":"/api-reference/workflows/workflow-templates/create-workflow-template"},{"title":"Get Workflow Template","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/templates/{workflow_template_id}","href":"/api-reference/workflows/workflow-templates/get-workflow-template"},{"title":"Delete Workflow Template","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/templates/{workflow_template_id}","href":"/api-reference/workflows/workflow-templates/delete-workflow-template"},{"title":"Update Workflow Template","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/templates/{workflow_template_id}","href":"/api-reference/workflows/workflow-templates/update-workflow-template"}]},{"group":"Simulations","pages":[{"title":"Get Simulation Schema","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/schema","href":"/api-reference/workflows/simulations/get-simulation-schema"},{"title":"Get Simulations","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations","href":"/api-reference/workflows/simulations/get-simulations"},{"title":"Create Simulation","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/simulations","href":"/api-reference/workflows/simulations/create-simulation"},{"title":"Get Simulation","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}","href":"/api-reference/workflows/simulations/get-simulation"},{"title":"Delete Simulation","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/simulations/{simulation_id}","href":"/api-reference/workflows/simulations/delete-simulation"},{"title":"Update Simulation","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/simulations/{simulation_id}","href":"/api-reference/workflows/simulations/update-simulation"},{"title":"Run Simulation","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/simulations/{simulation_id}/run","href":"/api-reference/workflows/simulations/run-simulation"},{"title":"Get Simulation Runs","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}/runs","href":"/api-reference/workflows/simulations/get-simulation-runs"},{"title":"Get Simulation Run Details","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{run_id}","href":"/api-reference/workflows/simulations/get-simulation-run-details"},{"title":"Stop Simulation Run","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json post /workflows/v1/simulation-runs/{run_id}/stop","href":"/api-reference/workflows/simulations/stop-simulation-run"},{"title":"Get Individual Runs For Group","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{group_id}/executions","href":"/api-reference/workflows/simulations/get-individual-runs-for-group"},{"title":"Get Simulation Evaluation Summary Endpoint","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}/evaluation-summary","href":"/api-reference/workflows/simulations/get-simulation-evaluation-summary-endpoint"},{"title":"Get Detailed Individual Runs For Group","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{group_id}/executions/detailed","href":"/api-reference/workflows/simulations/get-detailed-individual-runs-for-group"}]}]},{"group":"SMS","pages":[{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/campaigns","href":"/api-reference/sms/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns","href":"/api-reference/sms/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/sms/campaigns/get-campaign"},{"title":"Delete Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json delete /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/sms/campaigns/delete-campaign"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json patch /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/sms/campaigns/update-campaign"},{"title":"Campaign Action","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{campaign_id}/action","href":"/api-reference/sms/campaigns/campaign-action"},{"title":"Clone Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{campaign_id}/clone","href":"/api-reference/sms/campaigns/clone-campaign"},{"title":"Restore Campaign","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{campaign_id}/restore","href":"/api-reference/sms/campaigns/restore-campaign"}]},{"group":"Campaigns Calls","pages":[{"title":"Upload Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{campaign_id}/calls","href":"/api-reference/sms/campaigns-calls/upload-calls"},{"title":"Get Call Count","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/count","href":"/api-reference/sms/campaigns-calls/get-call-count"},{"title":"List Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/list","href":"/api-reference/sms/campaigns-calls/list-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/sms/campaigns-calls/get-call"},{"title":"Delete Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json delete /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/sms/campaigns-calls/delete-call"},{"title":"Update Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json patch /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/sms/campaigns-calls/update-call"},{"title":"Restore Call","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}/restore","href":"/api-reference/sms/campaigns-calls/restore-call"},{"title":"Download Calls","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{config_id}/calls/download","href":"/api-reference/sms/campaigns-calls/download-calls"},{"title":"Send Campaign Report Email","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/campaigns/{config_id}/calls/report","href":"/api-reference/sms/campaigns-calls/send-campaign-report-email"}]},{"group":"Campaign Bulk Calls","pages":[{"title":"Create Campaign Calls Bulk","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/schedule/calls","href":"/api-reference/sms/campaign-bulk-calls/create-campaign-calls-bulk"},{"title":"Get Call Status by ID","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/insurance-calling/calls/{call_id}/status","href":"/api-reference/sms/campaign-bulk-calls/get-call-status-by-id"},{"title":"Bulk Call Status","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/insurance-calling/calls/status","href":"/api-reference/sms/campaign-bulk-calls/bulk-call-status"}]},{"group":"Campaign Stats","pages":[{"title":"Campaign Call Stats","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/stats/campaigns/calls","href":"/api-reference/sms/campaign-stats/campaign-call-stats"},{"title":"Campaign Tags","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/stats/campaigns/tags","href":"/api-reference/sms/campaign-stats/campaign-tags"},{"title":"Campaign Stats","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/stats/campaigns","href":"/api-reference/sms/campaign-stats/campaign-stats"}]},{"group":"Contacts","pages":[{"title":"Get Contacts","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/contacts","href":"/api-reference/sms/contacts/get-contacts"},{"title":"Create New Contact","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json post /campaigns/v1/contacts","href":"/api-reference/sms/contacts/create-new-contact"},{"title":"Get Contacts Stats","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/contacts/stats","href":"/api-reference/sms/contacts/get-contacts-stats"},{"title":"Get Contact By Id","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json get /campaigns/v1/contacts/{contact_id}","href":"/api-reference/sms/contacts/get-contact-by-id"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json put /campaigns/v1/contacts/{contact_id}","href":"/api-reference/sms/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"https://api-prod.interactly.ai/api-docs/sms/api.json delete /campaigns/v1/contacts/{contact_id}","href":"/api-reference/sms/contacts/delete-contact"}]}]}],"global":{"anchors":[{"anchor":"Swagger","icon":"code","href":"https://api-prod.interactly.ai/api-docs"},{"anchor":"OpenAPI","icon":"code","href":"https://api-prod.interactly.ai/api-docs/api.json"}]}},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/release-notes"}]}]},"basePath":"","title":"Update Assistant - Interactly API","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}