API reference

AI Flows & Agents

6 endpoints. Add your API key in the authentication panel to send test requests from this page.

List AI agents (personification)

GET/api/external/v1/agents

Returns a paginated list of all AI agent personification personas available to the user. Agents are personifications of flows with specific settings (voice, language, knowledge base).

Parameters

pageinteger (int32)query
Page number (0-indexed)
sizeinteger (int32)query
Items per page (max 100)

Responses

200Paginated list of agents
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

List AI flows (logic)

GET/api/external/v1/flows

Returns a paginated list of all AI flows available to the user. Flows contain the AI instructions and logic. Use the apiId in your job creation requests.

Parameters

pageinteger (int32)query
Page number (0-indexed)
sizeinteger (int32)query
Items per page (max 100)

Responses

200Paginated list of flows
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Create AI flow

POST/api/external/v1/flows

Creates a new AI flow (logic configuration) for call or chat personification.

Request body application/json

idstring (uuid)
versioninteger (int32)
namestring
descriptionstring
iconKeystring
iconColorstring
apiIdstring
variableIdsarray of string (uuid)
structuredOutputIdsarray of string (uuid)
structuredInputIdsarray of string (uuid)
promptModuleIdsarray of string (uuid)
toolIdsarray of string (uuid)
dataSourceIdsarray of string (uuid)
pronunciationDictionaryIdsarray of string (uuid)
actionTriggerIdsarray of string (uuid)
localPronunciationDictionariesarray of object
localActionTriggersarray of object
actionTriggerStateVisibilityRulesobject
builtinToolIdsarray of string
localPromptModulesarray of object
localToolsarray of object
toolIntegrationCredentialLinksobject
toolActivationOverridesobject
toolMockModeOverridesobject
sessionStatesarray of object
toolStateVisibilityRulesobject
toolExecutionGuardsobject
toolAttachmentSettingsobject
Per attached tool, keyed like toolStateVisibilityRules: {runOnVoice, options}. runOnVoice: on the realtime speech engine, the voice model calls the tool itself instead of the brain (screen tools default to true). options: the tool's own settings.
outputStateVisibilityRulesobject
promptModuleStateVisibilityRulesobject
evaluationIdsarray of string (uuid)
evaluationStateVisibilityRulesobject
stateGraphobject
evaluationEnforcementstring
skillIdsarray of string (uuid)
builtinSkillIdsarray of string
localSkillsarray of object
skillActivationOverridesobject
skillLoadingModeOverridesobject
skillRealtimeVoiceOverridesobject
Realtime speech engine: per attached Skill, keyed like skillLoadingModeOverrides (global::<skillId>, local::<name>, sys::<name>), true puts a fully loaded Skill's content into the realtime voice's prompt too. Absent or false: the brain behind the voice holds it and the voice sees a catalog line.
skillLifecycleOverridesobject
skillInclusionModeOverridesobject
skillChildInclusionModeOverridesobject
knowledgeBaseLifecycleOverridesobject
skillStateVisibilityRulesobject
mcpServerIdsarray of string (uuid)
localMcpServersarray of object
multimediaLinksarray of object
mcpActivationOverridesobject
mcpExposureModeOverridesobject
mcpToolFilterOverridesobject
mcpInclusionOverridesobject
mcpStateVisibilityRulesobject
smartMcpConfigobject
conversationMemoryConfigobject
contextAttachmentsarray of object
agenticConfigobject
artificialSkillCatalogEnabledboolean
skillLoadToolEnabledboolean
skillReadToolEnabledboolean
skillManagementToolsEnabledboolean
localVariablesarray of object
localStructuredOutputsarray of object
localStructuredInputsarray of object
dataSourcesarray of object
knowledgeBaseobject
apiConfigobject
infrastructurePreferencesobject
workAutonomyConfigobject
automaticLearningConfigobject
workCompactionLearningConfigobject
sandboxConfigobject
sandboxDefinitionIdstring (uuid)
browserConfigobject
databaseConfigobject
databaseDefinitionIdstring (uuid)
workTaskModestring
knowledgeBaseRefsarray of object
knowledgeBaseStateVisibilityRulesobject
masterPromptstring
realtimeMasterPromptstring
Realtime speech engine, dual master prompt mode: the realtime voice model's own prompt. masterPrompt stays the prompt of the brain behind the voice (which runs every tool) and of every other engine and channel. Used only while infrastructurePreferences.speechEngine is "realtime" and infrastructurePreferences.realtimeDualMasterPrompt is true; blank falls back to masterPrompt.
firstMessagestring
aiDisclosureEnabledboolean
aiDisclosurePresetIdstring
aiDisclosurePlaceholderValuesobject
aiDisclosureCustomTextstring
aiDisclosurePrependTextstring
aiDisclosureAppendTextstring
voicemailMessagestring
voicemailDetectionEnabledboolean
voicemailDetectionMethodstring
keypadInputEnabledboolean
keypadInputTimeoutSecondsnumber (double)
keypadInputDelimitersarray of string
endSessionTriggerPhrasestring
endSessionMessagestring
masterPromptBackgroundSystemContextAutoAppendedboolean
timeZonestring
systemOutputEnabledboolean
stateContextMapEnabledboolean
stateContextJourneyEnabledboolean
stateContextConfigobject
backgroundContextInjectionToolRefsarray of string
backgroundContextInjectionToolArgsobject
languagestring
languagesarray of string
voiceIdstring
channelModestring
hybridVoiceChatInteractionsEnabledboolean
firstMessageModestring
forwardingPhoneNumberstring
userIdstring (uuid)
projectIdstring (uuid)
isTemplateboolean
referenceFlowIdstring (uuid)
bornFromTemplateboolean
templateDescriptionstring
templatePublicTitlestring
templateIconstring
templateImageUrlstring
templateIllustrationUrlstring
templateTagsarray of string
supportedLanguagesarray of string
templatePublishedboolean
templatePublicationLabelstring
templateOverrideStateFlowTemplateOverrideState
templateDetachModestring
templateDetachSourceFlowIdstring (uuid)
defaultApplicationIdstring (uuid)
archivedboolean
favoriteboolean
backgroundSoundstring
silenceTimeoutSecondsinteger (int32)
flowTriggersarray of object
maxDurationSecondsinteger (int32)
chatSessionTimeoutSecondsinteger (int32)
threadHistoryRememberingModestring
threadHistorySessionLimitinteger (int32)
threadHistoryMessageLimitinteger (int32)
backgroundDenoisingEnabledboolean
recordingEnabledboolean
transcriptStorageEnabledboolean
modelOutputInMessagesEnabledboolean
defaultTestCallPresetIdstring (uuid)
defaultTestCallPresetEnabledboolean
defaultTestChatPresetIdstring (uuid)
defaultTestChatPresetEnabledboolean
defaultTestCallSimulatedDirectionstring
defaultTestChatSimulatedDirectionstring
defaultTestCallFromPhoneNumberstring
defaultTestCallToPhoneNumberstring
confidenceThresholdnumber (double)
profanityFilterEnabledboolean
temperaturenumber (double)
waitSecondsnumber (double)
onPunctuationSecondsnumber (double)
onNoPunctuationSecondsnumber (double)
onNumberSecondsnumber (double)
onNumberDictationOnlyboolean
pitchnumber (double)
speednumber (double)
volumenumber (double)
inputMinCharactersinteger (int32)
voiceSecondsnumber (double)
backoffSecondsnumber (double)
numWordsinteger (int32)
acknowledgementPhrasesarray of string
interruptionPhrasesarray of string
interruptionTailGuardEnabledboolean
interruptionTailGuardMsinteger (int32)
voiceToolTurnMaxTokensinteger (int32)
voiceReplyMaxTokensinteger (int32)
pageReadTrimEnabledboolean
pageReadTrimThresholdTokensinteger (int32)
pronunciationDictionaryarray of object
onCallBeginToolRefsarray of string
onCallBeginToolIdstring (uuid)
onCallEndToolRefsarray of string
onCallEndToolIdstring (uuid)
onCallFailedToolRefsarray of string
onCallFailedToolIdstring (uuid)
onNoAnswerToolRefsarray of string
onNoAnswerToolIdstring (uuid)
onCallAttemptToolRefsarray of string
onCallAttemptToolIdstring (uuid)
onChatStartToolRefsarray of string
onChatStartToolIdstring (uuid)
onChatEndToolRefsarray of string
onChatEndToolIdstring (uuid)
onSessionBeginToolRefsarray of string
onSessionBeginToolIdstring (uuid)
onSessionEndToolRefsarray of string
onSessionEndToolIdstring (uuid)
onWorkBeginToolRefsarray of string
onWorkEndToolRefsarray of string
onWorkFailedToolRefsarray of string
onWorkCancelledToolRefsarray of string
onWorkNeedsAttentionToolRefsarray of string
onAfterAiAnalysisToolRefsarray of string
onAfterAiAnalysisToolIdstring (uuid)
onHumanSupportRequestedToolRefsarray of string
onHumanSupportRequestedToolIdstring (uuid)
onStateChangeToolRefsarray of string
onStateChangeToolIdstring (uuid)
onSessionStartActionsarray of object
onStateAlignmentToolRefsarray of string
onStateAlignmentToolIdstring (uuid)
mermaidCodestring
mermaidStatusstring
mermaidErrorstring
mermaidRequestedAtstring (date-time)
mermaidGeneratedAtstring (date-time)
aiEditableboolean
createdByAiboolean
createdAtstring (date-time)
updatedAtstring (date-time)
templateConfigIdsarray of string (uuid)
localTemplateConfigsarray of object
templateConfigScopeEnabledboolean

Responses

201Flow created successfully
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Get AI flow

GET/api/external/v1/flows/{flowId}

Retrieves the configuration details of a specific AI flow (logic flow) by its unique UUID.

Parameters

flowIdstring (uuid)pathRequired

Responses

200Flow details
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Update AI flow

PUT/api/external/v1/flows/{flowId}

Updates an existing AI flow. Only the fields present in the request body change; every field left out keeps its current value. Each field you send is replaced as a whole (an object or list field is not merged key by key), and an explicit null clears a field. Sending back a whole flow as returned by GET works too: id, userId, version and timestamps in the body are ignored.

Parameters

flowIdstring (uuid)pathRequired

Request body application/json

idstring (uuid)
versioninteger (int32)
namestring
descriptionstring
iconKeystring
iconColorstring
apiIdstring
variableIdsarray of string (uuid)
structuredOutputIdsarray of string (uuid)
structuredInputIdsarray of string (uuid)
promptModuleIdsarray of string (uuid)
toolIdsarray of string (uuid)
dataSourceIdsarray of string (uuid)
pronunciationDictionaryIdsarray of string (uuid)
actionTriggerIdsarray of string (uuid)
localPronunciationDictionariesarray of object
localActionTriggersarray of object
actionTriggerStateVisibilityRulesobject
builtinToolIdsarray of string
localPromptModulesarray of object
localToolsarray of object
toolIntegrationCredentialLinksobject
toolActivationOverridesobject
toolMockModeOverridesobject
sessionStatesarray of object
toolStateVisibilityRulesobject
toolExecutionGuardsobject
toolAttachmentSettingsobject
Per attached tool, keyed like toolStateVisibilityRules: {runOnVoice, options}. runOnVoice: on the realtime speech engine, the voice model calls the tool itself instead of the brain (screen tools default to true). options: the tool's own settings.
outputStateVisibilityRulesobject
promptModuleStateVisibilityRulesobject
evaluationIdsarray of string (uuid)
evaluationStateVisibilityRulesobject
stateGraphobject
evaluationEnforcementstring
skillIdsarray of string (uuid)
builtinSkillIdsarray of string
localSkillsarray of object
skillActivationOverridesobject
skillLoadingModeOverridesobject
skillRealtimeVoiceOverridesobject
Realtime speech engine: per attached Skill, keyed like skillLoadingModeOverrides (global::<skillId>, local::<name>, sys::<name>), true puts a fully loaded Skill's content into the realtime voice's prompt too. Absent or false: the brain behind the voice holds it and the voice sees a catalog line.
skillLifecycleOverridesobject
skillInclusionModeOverridesobject
skillChildInclusionModeOverridesobject
knowledgeBaseLifecycleOverridesobject
skillStateVisibilityRulesobject
mcpServerIdsarray of string (uuid)
localMcpServersarray of object
multimediaLinksarray of object
mcpActivationOverridesobject
mcpExposureModeOverridesobject
mcpToolFilterOverridesobject
mcpInclusionOverridesobject
mcpStateVisibilityRulesobject
smartMcpConfigobject
conversationMemoryConfigobject
contextAttachmentsarray of object
agenticConfigobject
artificialSkillCatalogEnabledboolean
skillLoadToolEnabledboolean
skillReadToolEnabledboolean
skillManagementToolsEnabledboolean
localVariablesarray of object
localStructuredOutputsarray of object
localStructuredInputsarray of object
dataSourcesarray of object
knowledgeBaseobject
apiConfigobject
infrastructurePreferencesobject
workAutonomyConfigobject
automaticLearningConfigobject
workCompactionLearningConfigobject
sandboxConfigobject
sandboxDefinitionIdstring (uuid)
browserConfigobject
databaseConfigobject
databaseDefinitionIdstring (uuid)
workTaskModestring
knowledgeBaseRefsarray of object
knowledgeBaseStateVisibilityRulesobject
masterPromptstring
realtimeMasterPromptstring
Realtime speech engine, dual master prompt mode: the realtime voice model's own prompt. masterPrompt stays the prompt of the brain behind the voice (which runs every tool) and of every other engine and channel. Used only while infrastructurePreferences.speechEngine is "realtime" and infrastructurePreferences.realtimeDualMasterPrompt is true; blank falls back to masterPrompt.
firstMessagestring
aiDisclosureEnabledboolean
aiDisclosurePresetIdstring
aiDisclosurePlaceholderValuesobject
aiDisclosureCustomTextstring
aiDisclosurePrependTextstring
aiDisclosureAppendTextstring
voicemailMessagestring
voicemailDetectionEnabledboolean
voicemailDetectionMethodstring
keypadInputEnabledboolean
keypadInputTimeoutSecondsnumber (double)
keypadInputDelimitersarray of string
endSessionTriggerPhrasestring
endSessionMessagestring
masterPromptBackgroundSystemContextAutoAppendedboolean
timeZonestring
systemOutputEnabledboolean
stateContextMapEnabledboolean
stateContextJourneyEnabledboolean
stateContextConfigobject
backgroundContextInjectionToolRefsarray of string
backgroundContextInjectionToolArgsobject
languagestring
languagesarray of string
voiceIdstring
channelModestring
hybridVoiceChatInteractionsEnabledboolean
firstMessageModestring
forwardingPhoneNumberstring
userIdstring (uuid)
projectIdstring (uuid)
isTemplateboolean
referenceFlowIdstring (uuid)
bornFromTemplateboolean
templateDescriptionstring
templatePublicTitlestring
templateIconstring
templateImageUrlstring
templateIllustrationUrlstring
templateTagsarray of string
supportedLanguagesarray of string
templatePublishedboolean
templatePublicationLabelstring
templateOverrideStateFlowTemplateOverrideState
templateDetachModestring
templateDetachSourceFlowIdstring (uuid)
defaultApplicationIdstring (uuid)
archivedboolean
favoriteboolean
backgroundSoundstring
silenceTimeoutSecondsinteger (int32)
flowTriggersarray of object
maxDurationSecondsinteger (int32)
chatSessionTimeoutSecondsinteger (int32)
threadHistoryRememberingModestring
threadHistorySessionLimitinteger (int32)
threadHistoryMessageLimitinteger (int32)
backgroundDenoisingEnabledboolean
recordingEnabledboolean
transcriptStorageEnabledboolean
modelOutputInMessagesEnabledboolean
defaultTestCallPresetIdstring (uuid)
defaultTestCallPresetEnabledboolean
defaultTestChatPresetIdstring (uuid)
defaultTestChatPresetEnabledboolean
defaultTestCallSimulatedDirectionstring
defaultTestChatSimulatedDirectionstring
defaultTestCallFromPhoneNumberstring
defaultTestCallToPhoneNumberstring
confidenceThresholdnumber (double)
profanityFilterEnabledboolean
temperaturenumber (double)
waitSecondsnumber (double)
onPunctuationSecondsnumber (double)
onNoPunctuationSecondsnumber (double)
onNumberSecondsnumber (double)
onNumberDictationOnlyboolean
pitchnumber (double)
speednumber (double)
volumenumber (double)
inputMinCharactersinteger (int32)
voiceSecondsnumber (double)
backoffSecondsnumber (double)
numWordsinteger (int32)
acknowledgementPhrasesarray of string
interruptionPhrasesarray of string
interruptionTailGuardEnabledboolean
interruptionTailGuardMsinteger (int32)
voiceToolTurnMaxTokensinteger (int32)
voiceReplyMaxTokensinteger (int32)
pageReadTrimEnabledboolean
pageReadTrimThresholdTokensinteger (int32)
pronunciationDictionaryarray of object
onCallBeginToolRefsarray of string
onCallBeginToolIdstring (uuid)
onCallEndToolRefsarray of string
onCallEndToolIdstring (uuid)
onCallFailedToolRefsarray of string
onCallFailedToolIdstring (uuid)
onNoAnswerToolRefsarray of string
onNoAnswerToolIdstring (uuid)
onCallAttemptToolRefsarray of string
onCallAttemptToolIdstring (uuid)
onChatStartToolRefsarray of string
onChatStartToolIdstring (uuid)
onChatEndToolRefsarray of string
onChatEndToolIdstring (uuid)
onSessionBeginToolRefsarray of string
onSessionBeginToolIdstring (uuid)
onSessionEndToolRefsarray of string
onSessionEndToolIdstring (uuid)
onWorkBeginToolRefsarray of string
onWorkEndToolRefsarray of string
onWorkFailedToolRefsarray of string
onWorkCancelledToolRefsarray of string
onWorkNeedsAttentionToolRefsarray of string
onAfterAiAnalysisToolRefsarray of string
onAfterAiAnalysisToolIdstring (uuid)
onHumanSupportRequestedToolRefsarray of string
onHumanSupportRequestedToolIdstring (uuid)
onStateChangeToolRefsarray of string
onStateChangeToolIdstring (uuid)
onSessionStartActionsarray of object
onStateAlignmentToolRefsarray of string
onStateAlignmentToolIdstring (uuid)
mermaidCodestring
mermaidStatusstring
mermaidErrorstring
mermaidRequestedAtstring (date-time)
mermaidGeneratedAtstring (date-time)
aiEditableboolean
createdByAiboolean
createdAtstring (date-time)
updatedAtstring (date-time)
templateConfigIdsarray of string (uuid)
localTemplateConfigsarray of object
templateConfigScopeEnabledboolean

Responses

200Flow updated successfully
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Delete AI flow

DELETE/api/external/v1/flows/{flowId}

Permanently deletes an AI flow by its unique UUID. This action cannot be undone.

Parameters

flowIdstring (uuid)pathRequired

Responses

204Flow deleted successfully
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found