API Reference
API Documentation
V3
- Get Started
- 📁 Workspaces
- 🤖 Agents
- Calls & Numbers
- 🔨 Tools
- ✖️ Variables
- 👥 Leads
- 🧠 Knowledge Base
Agents
- Introduction
- GETGet Agent
- POSTCreate/Edit Agent
- DELDelete Agent
- POSTChat Interact
- POSTConfigure State
- 🧠 Knowledge Base
- 💬 Conversations
- 📊 Analytics
Workspaces
- GETGet Workspace
- POSTEdit Workspace
- DELDelete Workspace
- 💼 Agency
- 🏢 Orgs
- 🤝 Clients
Update Agent
Updates an agent, this route must use the new V3 endpoints.
curl --request PATCH \
--url https://eu-voiceglow-runtime-vbmbkqccuq-ey.a.run.app/v3/agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent": {
"title": "<string>",
"description": "<string>",
"ownerID": "<string>",
"theme": "<string>",
"voiceConfig": {
"transcriber": {
"speechConfig": {
"format": "<string>",
"sampleRate": 123
},
"modelId": "<string>",
"patienceFactor": 123,
"language": "<string>",
"provider": "deepgram",
"randomOptions": "<any>",
"internal": {
"inputAudioStream": "<any>",
"debug": true
},
"apiKey": "<string>",
"platformSpecific": {
"deepgram": {
"modelId": "nova-3"
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123
},
"speechGen": {
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarityBoost": 123,
"style": 123,
"useSpeakerBoost": true
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true
}
},
"disabled": true,
"vectorDb": "<any>",
"withRefresh": true,
"agentPlatform": "<any>",
"ID": "<string>",
"storageID": "<string>",
"VF_DIALOGUE_API_KEY": "<string>",
"VF_PROJECT_API_KEY": "<string>",
"VF_PROJECT_ID": "<string>",
"VF_KB_API_KEY": "<string>",
"roundedImageURL": "<string>",
"rectangeImageURL": "<string>",
"messageDelayMS": 123,
"scrollAnimation": true,
"proactiveMessage": "<string>",
"acceptFileUpload": true,
"recordChatHistory": true,
"chatBgURL": "<string>",
"disableSmoothScroll": true,
"isDeployed": true,
"tokensUsage": "<any>",
"maxTokensUsage": "<any>",
"lastModified": 123,
"fontFamily": "<string>",
"branding": "<string>",
"customThemeJSONString": "<string>",
"autoStartWidget": true,
"allTimeTriggers": 123,
"syncBrowser": true,
"delayBeforeSubmit": 123,
"region": "eu",
"listenForUrlChanges": true,
"chatForget": true,
"lang": "<string>",
"enableAudioSupport": true,
"AITranslateTo": "<string>",
"enableAITranslate": true,
"disableNoReplyListener": true,
"disableHumanHandoff": true,
"alwaysShowHandoff": true,
"manualControl": true,
"enableVGHandoff": true,
"enableGeoAnalytics": true,
"fixedHandoffPopup": true,
"buttonsLayout": "horizontal",
"ADVANCED_customCSS": "<string>",
"messagesLimit": 123,
"whatsappToken": "<string>",
"whatsappNumberId": "<string>",
"whatsappBusniessId": "<string>",
"waTestNumber": "<string>",
"waVerifyPassed": true,
"waTestPassed": true,
"webhookUrl": "<string>",
"gcloudPrivateKey": "<string>",
"gcloudClientEmail": "<string>",
"smartInit": true,
"UIhandoffTitle": "<string>",
"UIhandoffSubtitle": "<string>",
"igVerified": true,
"igAccessToken": "<string>",
"showHandoffEvenIfOffline": true,
"customButtonJSON_STRING": "<string>",
"vg_initPrompt": "<string>",
"vg_prompt": "<string>",
"vg_initMessages": [
"<string>"
],
"vg_systemPrompt": "<string>",
"vg_temperature": 123,
"vg_defaultModel": "gpt-3.5-turbo-0125",
"vg_maxTokens": 123,
"vg_kbDefaultDimension": 123,
"vg_kbTopChunks": 123,
"SECRET_API_KEY": "<string>",
"vg_kbCharCount": 123,
"vg_kbDocsNum": 123,
"vg_enableUIEngine": true,
"vg_enableAboutContext": true,
"vg_kb_llm": {
"searchMethod": "smart",
"searchPrompt": "<string>",
"modelId": "gpt-3.5-turbo-0125",
"temprature": 123,
"maxTokens": 123
},
"vg_max_messages_history": 123,
"ifKnowsThreshold": 123,
"avatarImageUrl": "<string>",
"headerImageUrl": "<string>",
"bannerImageUrl": "<string>",
"soundEffectUrl": "<string>",
"soundEffectEnabled": true,
"enableQuickFileUpload": true,
"instagramOptions": {
"pageId": "<string>",
"accessToken": "<string>"
},
"translateUserResponse": true,
"starred": true,
"flowise": {
"webhookUrl": "<string>",
"webhookSecret": "<string>"
},
"vfSettings": {
"enableIgnoreUrlPaths": true
},
"vapi": "<any>",
"vapiConfig": {
"syncKbOnSave": true,
"PUBLIC_API_KEY": "<string>",
"PRIVATE_API_KEY": "<string>",
"enableVapiOnWeb": true,
"overrideWithVG": true,
"promptOnWeb": true,
"maxCostMonthly": 123,
"maxMinutesMonthly": 123,
"useVfProject": true,
"syncTools": true
},
"vgOptions": {
"isLlmStudio": true,
"showSources": true,
"lightUiEngine": true,
"legacyKb": true,
"maxChunkSize": 123,
"handoffTimeout": 123
},
"ui": {
"bgImageVisible": true,
"widgetType": "direct-chat",
"enableFixedFeedbackBtns": true,
"voice": {
"question": "<string>",
"continueBtnLabel": "<string>",
"dismissBtnLabel": "<string>"
}
},
"assignedToolsIds": [
"<string>"
],
"tools": [
{
"isDefault": true,
"method": "GET",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"variablesIds": [
"<string>"
],
"agentId": "<string>",
"userId": "<string>",
"backchannellingPhrases": [
"<string>"
],
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
],
"internal": {
"accountCreationConfig": "v2",
"websocketServer": "edge",
"setOnResponse": true,
"enableSetOnLoad": true
},
"disableAutoTranscribeAudio": true,
"instaAgentUsername": "<string>",
"convoTags": [
"<string>"
],
"vfConfig": {
"alwaysEnableCardButtons": true
},
"discord": {
"channelIds": [
"<string>"
],
"webhookUrls": [
"<string>"
]
},
"limits": {
"maxInteractionsPerUserId": 123
},
"tabs": [
"<any>"
],
"kbTags": [
"<string>"
],
"kbTagsDataMap": [
"<any>"
],
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"isGlobal": true,
"toolsIds": [
"<string>"
],
"childrenNodes": [
{
"nodeId": "<string>",
"condition": "<string>"
}
],
"llmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"routerLlmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"toolUseBias": 123,
"autoRerouter": {
"enabled": true,
"level": 123
},
"type": "start",
"rf": "<any>",
"kb": {
"enabled": true,
"maxChunks": 123,
"tags": [
"<string>"
],
"smartSearch": true
},
"preStart": {
"url": "<string>",
"enabled": true
}
}
],
"enableNodes": true,
"advanced": {
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"nodesSettings": {
"appendBeforePrompt": "<string>",
"routerLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"defaultLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"backchannelOnChoosingNodes": true,
"enableUiEngine": true
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
}
}
}'{
"success": true,
"message": "<string>",
"data": {
"title": "<string>",
"description": "<string>",
"ownerID": "<string>",
"theme": "<string>",
"voiceConfig": {
"transcriber": {
"speechConfig": {
"format": "<string>",
"sampleRate": 123
},
"modelId": "<string>",
"patienceFactor": 123,
"language": "<string>",
"provider": "deepgram",
"randomOptions": "<any>",
"internal": {
"inputAudioStream": "<any>",
"debug": true
},
"apiKey": "<string>",
"platformSpecific": {
"deepgram": {
"modelId": "nova-3"
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123
},
"speechGen": {
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarityBoost": 123,
"style": 123,
"useSpeakerBoost": true
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true
}
},
"disabled": true,
"vectorDb": "<any>",
"withRefresh": true,
"agentPlatform": "<any>",
"ID": "<string>",
"storageID": "<string>",
"VF_DIALOGUE_API_KEY": "<string>",
"VF_PROJECT_API_KEY": "<string>",
"VF_PROJECT_ID": "<string>",
"VF_KB_API_KEY": "<string>",
"roundedImageURL": "<string>",
"rectangeImageURL": "<string>",
"messageDelayMS": 123,
"scrollAnimation": true,
"proactiveMessage": "<string>",
"acceptFileUpload": true,
"recordChatHistory": true,
"chatBgURL": "<string>",
"disableSmoothScroll": true,
"isDeployed": true,
"tokensUsage": "<any>",
"maxTokensUsage": "<any>",
"lastModified": 123,
"fontFamily": "<string>",
"branding": "<string>",
"customThemeJSONString": "<string>",
"autoStartWidget": true,
"allTimeTriggers": 123,
"syncBrowser": true,
"delayBeforeSubmit": 123,
"region": "eu",
"listenForUrlChanges": true,
"chatForget": true,
"lang": "<string>",
"enableAudioSupport": true,
"AITranslateTo": "<string>",
"enableAITranslate": true,
"disableNoReplyListener": true,
"disableHumanHandoff": true,
"alwaysShowHandoff": true,
"manualControl": true,
"enableVGHandoff": true,
"enableGeoAnalytics": true,
"fixedHandoffPopup": true,
"buttonsLayout": "horizontal",
"ADVANCED_customCSS": "<string>",
"messagesLimit": 123,
"whatsappToken": "<string>",
"whatsappNumberId": "<string>",
"whatsappBusniessId": "<string>",
"waTestNumber": "<string>",
"waVerifyPassed": true,
"waTestPassed": true,
"webhookUrl": "<string>",
"gcloudPrivateKey": "<string>",
"gcloudClientEmail": "<string>",
"smartInit": true,
"UIhandoffTitle": "<string>",
"UIhandoffSubtitle": "<string>",
"igVerified": true,
"igAccessToken": "<string>",
"showHandoffEvenIfOffline": true,
"customButtonJSON_STRING": "<string>",
"vg_initPrompt": "<string>",
"vg_prompt": "<string>",
"vg_initMessages": [
"<string>"
],
"vg_systemPrompt": "<string>",
"vg_temperature": 123,
"vg_defaultModel": "gpt-3.5-turbo-0125",
"vg_maxTokens": 123,
"vg_kbDefaultDimension": 123,
"vg_kbTopChunks": 123,
"SECRET_API_KEY": "<string>",
"vg_kbCharCount": 123,
"vg_kbDocsNum": 123,
"vg_enableUIEngine": true,
"vg_enableAboutContext": true,
"vg_kb_llm": {
"searchMethod": "smart",
"searchPrompt": "<string>",
"modelId": "gpt-3.5-turbo-0125",
"temprature": 123,
"maxTokens": 123
},
"vg_max_messages_history": 123,
"ifKnowsThreshold": 123,
"avatarImageUrl": "<string>",
"headerImageUrl": "<string>",
"bannerImageUrl": "<string>",
"soundEffectUrl": "<string>",
"soundEffectEnabled": true,
"enableQuickFileUpload": true,
"instagramOptions": {
"pageId": "<string>",
"accessToken": "<string>"
},
"translateUserResponse": true,
"starred": true,
"flowise": {
"webhookUrl": "<string>",
"webhookSecret": "<string>"
},
"vfSettings": {
"enableIgnoreUrlPaths": true
},
"vapi": "<any>",
"vapiConfig": {
"syncKbOnSave": true,
"PUBLIC_API_KEY": "<string>",
"PRIVATE_API_KEY": "<string>",
"enableVapiOnWeb": true,
"overrideWithVG": true,
"promptOnWeb": true,
"maxCostMonthly": 123,
"maxMinutesMonthly": 123,
"useVfProject": true,
"syncTools": true
},
"vgOptions": {
"isLlmStudio": true,
"showSources": true,
"lightUiEngine": true,
"legacyKb": true,
"maxChunkSize": 123,
"handoffTimeout": 123
},
"ui": {
"bgImageVisible": true,
"widgetType": "direct-chat",
"enableFixedFeedbackBtns": true,
"voice": {
"question": "<string>",
"continueBtnLabel": "<string>",
"dismissBtnLabel": "<string>"
}
},
"assignedToolsIds": [
"<string>"
],
"tools": [
{
"isDefault": true,
"method": "GET",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"variablesIds": [
"<string>"
],
"agentId": "<string>",
"userId": "<string>",
"backchannellingPhrases": [
"<string>"
],
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
],
"internal": {
"accountCreationConfig": "v2",
"websocketServer": "edge",
"setOnResponse": true,
"enableSetOnLoad": true
},
"disableAutoTranscribeAudio": true,
"instaAgentUsername": "<string>",
"convoTags": [
"<string>"
],
"vfConfig": {
"alwaysEnableCardButtons": true
},
"discord": {
"channelIds": [
"<string>"
],
"webhookUrls": [
"<string>"
]
},
"limits": {
"maxInteractionsPerUserId": 123
},
"tabs": [
"<any>"
],
"kbTags": [
"<string>"
],
"kbTagsDataMap": [
"<any>"
],
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"isGlobal": true,
"toolsIds": [
"<string>"
],
"childrenNodes": [
{
"nodeId": "<string>",
"condition": "<string>"
}
],
"llmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"routerLlmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"toolUseBias": 123,
"autoRerouter": {
"enabled": true,
"level": 123
},
"type": "start",
"rf": "<any>",
"kb": {
"enabled": true,
"maxChunks": 123,
"tags": [
"<string>"
],
"smartSearch": true
},
"preStart": {
"url": "<string>",
"enabled": true
}
}
],
"enableNodes": true,
"advanced": {
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"nodesSettings": {
"appendBeforePrompt": "<string>",
"routerLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"defaultLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"backchannelOnChoosingNodes": true,
"enableUiEngine": true
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Title: The title of the agent.
Description: A brief description of the agent.
Owner ID: The unique identifier of the agent's owner.
Theme: The visual theme of the agent, e.g., 'blue-light' or 'custom-blue-dark'.
Transcriber: The configuration options for the transcriber provider used by the agent.
deepgram, gladia, assemblyai, speechmatics Speech Generation: The configuration options for the speech generation provider used by the agent.
Speech providers supported by the app.
elevenlabs, cartesia, playht, azure, rime-ai, openai The model id of the speech gen.
The voice id for the speech service.
restaurant, office, park, street Whether to say umm, sure, etc.. when the user is talking for too long.
Indicates whether the agent is disabled. If set to true, the agent will not be active.
Specifies the vector database configuration for the agent. This database is used for handling vectorized data or embeddings.
Determines whether the agent should refresh its settings or data dynamically.
Specifies the platform on which the agent operates, such as web, mobile, or other environments.
A unique identifier for the agent used internally.
The identifier for the agent's storage configuration.
API key for VF dialogue integration, enabling the agent to communicate with external systems.
API key associated with the VF project to authenticate and enable specific functionalities.
The unique identifier of the VF project linked to the agent.
API key for accessing the VF knowledge base, enabling advanced knowledge retrieval capabilities.
URL pointing to the rounded image asset used to visually represent the agent.
URL pointing to the rectangular image asset for the agent's branding or display.
Specifies the delay in milliseconds for the agent to send messages, simulating natural conversation timing.
Indicates whether scroll animations are enabled for smooth transitions in the chat interface.
A predefined message the agent sends proactively to engage users.
Determines if the agent accepts file uploads from users as part of the interaction.
Specifies whether the agent logs chat histories for future reference or analysis.
URL of the background image used in the chat interface.
Disables smooth scrolling if set to true, potentially improving performance on low-end devices.
Indicates whether the agent is currently deployed and operational.
Tracks the token usage statistics for the agent, typically used in LLM integrations.
Defines the maximum allowable token usage for the agent to prevent overconsumption.
The timestamp of the last modification made to the agent's configuration.
The font family used in the agent's user interface for consistent branding.
Custom branding information or labels associated with the agent.
A JSON string defining a custom theme for the agent's interface.
Determines if the widget should auto-start upon page load.
The total number of triggers or interactions the agent has handled.
Enables synchronization of settings or states with the browser session.
The delay (in milliseconds) before submitting user input to the agent.
Defines the geographical region settings for the agent, such as localization.
eu, na Specifies if the agent should monitor and react to changes in the browser URL.
If enabled, the agent will not retain previous chat interactions for privacy reasons.
Specifies the default language for the agent's interactions and responses.
Enables audio features, allowing the agent to process and respond to audio inputs.
Defines the target language for AI translation during interactions.
Activates AI-based translation for multilingual support.
Disables the listener for instances where no reply is detected from the agent.
Prevents the agent from escalating interactions to a human operator.
Ensures the handoff option is always visible, regardless of agent status.
Allows manual control over specific agent functionalities.
Activates VG-specific handoff mechanisms for the agent.
Enables geographic analytics to track user interactions based on location.
Ensures the handoff popup remains fixed in the interface.
Defines the layout and style of buttons in the agent's interface.
horizontal, vertical, in-footer Specifies advanced custom CSS for overriding the default styling of the agent's interface.
Sets a cap on the number of messages the agent can exchange in a single session.
Token for authenticating and integrating with WhatsApp services.
The ID associated with the WhatsApp number used by the agent.
The business ID for WhatsApp integration, enabling enterprise-level features.
A test number used during WhatsApp integration setup or testing.
Indicates if WhatsApp verification was successfully completed.
Indicates if the WhatsApp integration test was successful.
The URL where the agent sends webhook events to external systems.
Private key for Google Cloud services integration.
Client email for Google Cloud authentication.
Activates smart initialization features for the agent.
Title displayed during UI handoff interactions.
Subtitle displayed during UI handoff interactions.
Indicates if the agent's Instagram integration is verified.
Access token for authenticating Instagram API requests.
Displays the handoff option even if the agent is offline.
JSON string defining custom buttons for the agent's interface.
The initial prompt displayed or used by the VF system.
The main prompt template used for generating responses.
Initial messages loaded for the agent's conversation flow.
System-level prompt defining the agent's behavior and rules.
Defines the temperature setting for response variability in the VF model.
Specifies the default LLM model used by the agent for language processing.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b Sets the maximum token limit for generating responses.
Default dimensionality for the agent's knowledge base embeddings.
The number of top chunks retrieved from the knowledge base during a query.
The secret API key for secure integration with VF services.
Tracks the total character count of the agent's knowledge base.
The total number of documents stored in the agent's knowledge base.
Activates the UI engine for enhanced interface capabilities.
Enables contextual information about the agent for users.
Configuration for LLM-based knowledge base queries, including search methods and model parameters.
smart gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b Maximum number of messages retained in the chat history.
Confidence threshold for determining if the agent 'knows' an answer.
URL of the avatar image representing the agent.
URL of the header image displayed in the chat interface.
URL of the banner image used in the agent's branding.
URL of the sound effect file used for agent interactions.
Enables or disables sound effects for the agent.
Allows quick file uploads during chat interactions.
A unique identifier for the tool. Ensures distinct identification within the system.
The name of the tool, providing a human-readable identifier for display purposes.
A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.
Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.
The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.
GET, POST, PUT, PATCH The server URL where the tool's operations are performed. Used for network-based integrations.
A secret token or key associated with the server URL. Provides secure access to the tool's backend services.
The timestamp when the tool was created, formatted as an ISO 8601 string. Useful for tracking tool lifecycle.
The timestamp when the tool was last updated, formatted as an ISO 8601 string. Useful for versioning and auditing.
Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.
Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.
A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.
If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.
An array of variable IDs associated with the tool. Each ID maps to a specific variable used by the tool.
The unique identifier of the agent associated with this tool. Helps in linking the tool to a specific agent.
The unique identifier of the user associated with this tool. Used for user-specific configurations and access control.
An array of phrases used for backchannel communication. These phrases help in maintaining conversational flow.
A unique identifier for the field, ensuring it is distinct across the system.
Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.
Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.
string, number, boolean, system The current assigned value of the field. This value is optional and supports any type depending on the field's context.
A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.
The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.
A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.
Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.
Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.
Specifies if this field represents an environment variable, typically used for configuration or deployment.
Indicates whether this field is a system-level variable, reserved for core operations or internal use.
If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.
References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.
References the unique identifier of the user associated with this field. Useful for user-specific customizations.
The channels that the tool can be used on.
web-chat, whatsapp, instagram, telegram, discord, gb-chat, vapi, messenger, voice, telephony A short description of what this node does and when it should be used, specially useful if the node is global or when the LLM detects automatic rerouting.
What should this LLM node do.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
If true, this node will be always present for the LLM
The tools that will be available for this node
The outputs of this node which the node after finishing will choose from to either advance or to keep looping in this node till it caputures or reaches one of the mentioned routers.
The LLM config that will be used for the router node, NOTE: This must be a fast LLM model or the latency will be too high between responses.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
The bias of the LLM to use tools if 0 it will never use tools, if 1 it will only use tools.
The auto rerouter of this node.
If true, the LLM will try to detect if the user has changed his mind about something enabling the AI to rewind back to the previous node.
The level of rewinding, if 1 the LLM will have access to only 1 level or rewind capabilities meaning if it went from node A > B > C > D then if it at node d & it detects it needs to be at node B again it will be able to rewind back to node B if the level is at least 2, it will not be able to detect node A unless the level is 3 or more, and so on.
The type of the node, if not provided it will be a normal LLM node.
start, end, default The position of the node in the reactflow canvas.
The pre start tool of the node, we will send a GET request to this URL before starting the node and provide the results to the AI. GET {url}/{user_id}/{node_name}
The prompt to append to the nodes' prompt.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
If true, the LLM will say uha/i see before choosing a node.
If true, the LLM will be able to show buttons, cards, images on text channels only.
Enable fallback for the agent llm model.
Fallback settings for the agent llm model.
The model to use for fallback.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The credit threshold for fallback.
Response
Title: The title of the agent.
Description: A brief description of the agent.
Owner ID: The unique identifier of the agent's owner.
Theme: The visual theme of the agent, e.g., 'blue-light' or 'custom-blue-dark'.
Transcriber: The configuration options for the transcriber provider used by the agent.
deepgram, gladia, assemblyai, speechmatics Speech Generation: The configuration options for the speech generation provider used by the agent.
Speech providers supported by the app.
elevenlabs, cartesia, playht, azure, rime-ai, openai The model id of the speech gen.
The voice id for the speech service.
restaurant, office, park, street Whether to say umm, sure, etc.. when the user is talking for too long.
Indicates whether the agent is disabled. If set to true, the agent will not be active.
Specifies the vector database configuration for the agent. This database is used for handling vectorized data or embeddings.
Determines whether the agent should refresh its settings or data dynamically.
Specifies the platform on which the agent operates, such as web, mobile, or other environments.
A unique identifier for the agent used internally.
The identifier for the agent's storage configuration.
API key for VF dialogue integration, enabling the agent to communicate with external systems.
API key associated with the VF project to authenticate and enable specific functionalities.
The unique identifier of the VF project linked to the agent.
API key for accessing the VF knowledge base, enabling advanced knowledge retrieval capabilities.
URL pointing to the rounded image asset used to visually represent the agent.
URL pointing to the rectangular image asset for the agent's branding or display.
Specifies the delay in milliseconds for the agent to send messages, simulating natural conversation timing.
Indicates whether scroll animations are enabled for smooth transitions in the chat interface.
A predefined message the agent sends proactively to engage users.
Determines if the agent accepts file uploads from users as part of the interaction.
Specifies whether the agent logs chat histories for future reference or analysis.
URL of the background image used in the chat interface.
Disables smooth scrolling if set to true, potentially improving performance on low-end devices.
Indicates whether the agent is currently deployed and operational.
Tracks the token usage statistics for the agent, typically used in LLM integrations.
Defines the maximum allowable token usage for the agent to prevent overconsumption.
The timestamp of the last modification made to the agent's configuration.
The font family used in the agent's user interface for consistent branding.
Custom branding information or labels associated with the agent.
A JSON string defining a custom theme for the agent's interface.
Determines if the widget should auto-start upon page load.
The total number of triggers or interactions the agent has handled.
Enables synchronization of settings or states with the browser session.
The delay (in milliseconds) before submitting user input to the agent.
Defines the geographical region settings for the agent, such as localization.
eu, na Specifies if the agent should monitor and react to changes in the browser URL.
If enabled, the agent will not retain previous chat interactions for privacy reasons.
Specifies the default language for the agent's interactions and responses.
Enables audio features, allowing the agent to process and respond to audio inputs.
Defines the target language for AI translation during interactions.
Activates AI-based translation for multilingual support.
Disables the listener for instances where no reply is detected from the agent.
Prevents the agent from escalating interactions to a human operator.
Ensures the handoff option is always visible, regardless of agent status.
Allows manual control over specific agent functionalities.
Activates VG-specific handoff mechanisms for the agent.
Enables geographic analytics to track user interactions based on location.
Ensures the handoff popup remains fixed in the interface.
Defines the layout and style of buttons in the agent's interface.
horizontal, vertical, in-footer Specifies advanced custom CSS for overriding the default styling of the agent's interface.
Sets a cap on the number of messages the agent can exchange in a single session.
Token for authenticating and integrating with WhatsApp services.
The ID associated with the WhatsApp number used by the agent.
The business ID for WhatsApp integration, enabling enterprise-level features.
A test number used during WhatsApp integration setup or testing.
Indicates if WhatsApp verification was successfully completed.
Indicates if the WhatsApp integration test was successful.
The URL where the agent sends webhook events to external systems.
Private key for Google Cloud services integration.
Client email for Google Cloud authentication.
Activates smart initialization features for the agent.
Title displayed during UI handoff interactions.
Subtitle displayed during UI handoff interactions.
Indicates if the agent's Instagram integration is verified.
Access token for authenticating Instagram API requests.
Displays the handoff option even if the agent is offline.
JSON string defining custom buttons for the agent's interface.
The initial prompt displayed or used by the VF system.
The main prompt template used for generating responses.
Initial messages loaded for the agent's conversation flow.
System-level prompt defining the agent's behavior and rules.
Defines the temperature setting for response variability in the VF model.
Specifies the default LLM model used by the agent for language processing.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b Sets the maximum token limit for generating responses.
Default dimensionality for the agent's knowledge base embeddings.
The number of top chunks retrieved from the knowledge base during a query.
The secret API key for secure integration with VF services.
Tracks the total character count of the agent's knowledge base.
The total number of documents stored in the agent's knowledge base.
Activates the UI engine for enhanced interface capabilities.
Enables contextual information about the agent for users.
Configuration for LLM-based knowledge base queries, including search methods and model parameters.
smart gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b Maximum number of messages retained in the chat history.
Confidence threshold for determining if the agent 'knows' an answer.
URL of the avatar image representing the agent.
URL of the header image displayed in the chat interface.
URL of the banner image used in the agent's branding.
URL of the sound effect file used for agent interactions.
Enables or disables sound effects for the agent.
Allows quick file uploads during chat interactions.
A unique identifier for the tool. Ensures distinct identification within the system.
The name of the tool, providing a human-readable identifier for display purposes.
A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.
Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.
The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.
GET, POST, PUT, PATCH The server URL where the tool's operations are performed. Used for network-based integrations.
A secret token or key associated with the server URL. Provides secure access to the tool's backend services.
The timestamp when the tool was created, formatted as an ISO 8601 string. Useful for tracking tool lifecycle.
The timestamp when the tool was last updated, formatted as an ISO 8601 string. Useful for versioning and auditing.
Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.
Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.
A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.
If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.
An array of variable IDs associated with the tool. Each ID maps to a specific variable used by the tool.
The unique identifier of the agent associated with this tool. Helps in linking the tool to a specific agent.
The unique identifier of the user associated with this tool. Used for user-specific configurations and access control.
An array of phrases used for backchannel communication. These phrases help in maintaining conversational flow.
A unique identifier for the field, ensuring it is distinct across the system.
Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.
Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.
string, number, boolean, system The current assigned value of the field. This value is optional and supports any type depending on the field's context.
A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.
The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.
A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.
Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.
Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.
Specifies if this field represents an environment variable, typically used for configuration or deployment.
Indicates whether this field is a system-level variable, reserved for core operations or internal use.
If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.
References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.
References the unique identifier of the user associated with this field. Useful for user-specific customizations.
The channels that the tool can be used on.
web-chat, whatsapp, instagram, telegram, discord, gb-chat, vapi, messenger, voice, telephony A short description of what this node does and when it should be used, specially useful if the node is global or when the LLM detects automatic rerouting.
What should this LLM node do.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
If true, this node will be always present for the LLM
The tools that will be available for this node
The outputs of this node which the node after finishing will choose from to either advance or to keep looping in this node till it caputures or reaches one of the mentioned routers.
The LLM config that will be used for the router node, NOTE: This must be a fast LLM model or the latency will be too high between responses.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
The bias of the LLM to use tools if 0 it will never use tools, if 1 it will only use tools.
The auto rerouter of this node.
If true, the LLM will try to detect if the user has changed his mind about something enabling the AI to rewind back to the previous node.
The level of rewinding, if 1 the LLM will have access to only 1 level or rewind capabilities meaning if it went from node A > B > C > D then if it at node d & it detects it needs to be at node B again it will be able to rewind back to node B if the level is at least 2, it will not be able to detect node A unless the level is 3 or more, and so on.
The type of the node, if not provided it will be a normal LLM node.
start, end, default The position of the node in the reactflow canvas.
The pre start tool of the node, we will send a GET request to this URL before starting the node and provide the results to the AI. GET {url}/{user_id}/{node_name}
The prompt to append to the nodes' prompt.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The temperature of the LLM
The max tokens of the LLM
If true, the LLM will say uha/i see before choosing a node.
If true, the LLM will be able to show buttons, cards, images on text channels only.
Enable fallback for the agent llm model.
Fallback settings for the agent llm model.
The model to use for fallback.
gpt-3.5-turbo-0125, gpt-4-1106-preview, gpt-4o, gpt-4o-mini, ft:gpt-4o-mini-2024-07-18:personal:4o-with-tools-t11:A6mByttv, llama3-8b-8192, llama3-70b-8192, llama-3.1-8b-instant, llama-3.1-70b-versatile, llama-3.2-90b-text-preview, llama-3.2-11b-text-preview, llama-3.3-70b-versatile, mixtral-8x7b-32768, gemma-7b-it, gemma2-9b-it, claude-3-5-sonnet-20240620, claude-3-5-sonnet-20241022, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307, claude-3-5-haiku-20241022, gemini-1.5-pro, gemini-1.5-flash, gemini-1.0-pro, gemini-2.0-flash-exp, gemini-2.0-flash-thinking-exp-1219, gpt-4-32k, gpt-4, gpt-3.5-turbo-16k, gpt-3.5-turbo, deepseek-chat, deepseek-r1-distill-llama-70b The credit threshold for fallback.
curl --request PATCH \
--url https://eu-voiceglow-runtime-vbmbkqccuq-ey.a.run.app/v3/agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"agent": {
"title": "<string>",
"description": "<string>",
"ownerID": "<string>",
"theme": "<string>",
"voiceConfig": {
"transcriber": {
"speechConfig": {
"format": "<string>",
"sampleRate": 123
},
"modelId": "<string>",
"patienceFactor": 123,
"language": "<string>",
"provider": "deepgram",
"randomOptions": "<any>",
"internal": {
"inputAudioStream": "<any>",
"debug": true
},
"apiKey": "<string>",
"platformSpecific": {
"deepgram": {
"modelId": "nova-3"
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123
},
"speechGen": {
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarityBoost": 123,
"style": 123,
"useSpeakerBoost": true
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true
}
},
"disabled": true,
"vectorDb": "<any>",
"withRefresh": true,
"agentPlatform": "<any>",
"ID": "<string>",
"storageID": "<string>",
"VF_DIALOGUE_API_KEY": "<string>",
"VF_PROJECT_API_KEY": "<string>",
"VF_PROJECT_ID": "<string>",
"VF_KB_API_KEY": "<string>",
"roundedImageURL": "<string>",
"rectangeImageURL": "<string>",
"messageDelayMS": 123,
"scrollAnimation": true,
"proactiveMessage": "<string>",
"acceptFileUpload": true,
"recordChatHistory": true,
"chatBgURL": "<string>",
"disableSmoothScroll": true,
"isDeployed": true,
"tokensUsage": "<any>",
"maxTokensUsage": "<any>",
"lastModified": 123,
"fontFamily": "<string>",
"branding": "<string>",
"customThemeJSONString": "<string>",
"autoStartWidget": true,
"allTimeTriggers": 123,
"syncBrowser": true,
"delayBeforeSubmit": 123,
"region": "eu",
"listenForUrlChanges": true,
"chatForget": true,
"lang": "<string>",
"enableAudioSupport": true,
"AITranslateTo": "<string>",
"enableAITranslate": true,
"disableNoReplyListener": true,
"disableHumanHandoff": true,
"alwaysShowHandoff": true,
"manualControl": true,
"enableVGHandoff": true,
"enableGeoAnalytics": true,
"fixedHandoffPopup": true,
"buttonsLayout": "horizontal",
"ADVANCED_customCSS": "<string>",
"messagesLimit": 123,
"whatsappToken": "<string>",
"whatsappNumberId": "<string>",
"whatsappBusniessId": "<string>",
"waTestNumber": "<string>",
"waVerifyPassed": true,
"waTestPassed": true,
"webhookUrl": "<string>",
"gcloudPrivateKey": "<string>",
"gcloudClientEmail": "<string>",
"smartInit": true,
"UIhandoffTitle": "<string>",
"UIhandoffSubtitle": "<string>",
"igVerified": true,
"igAccessToken": "<string>",
"showHandoffEvenIfOffline": true,
"customButtonJSON_STRING": "<string>",
"vg_initPrompt": "<string>",
"vg_prompt": "<string>",
"vg_initMessages": [
"<string>"
],
"vg_systemPrompt": "<string>",
"vg_temperature": 123,
"vg_defaultModel": "gpt-3.5-turbo-0125",
"vg_maxTokens": 123,
"vg_kbDefaultDimension": 123,
"vg_kbTopChunks": 123,
"SECRET_API_KEY": "<string>",
"vg_kbCharCount": 123,
"vg_kbDocsNum": 123,
"vg_enableUIEngine": true,
"vg_enableAboutContext": true,
"vg_kb_llm": {
"searchMethod": "smart",
"searchPrompt": "<string>",
"modelId": "gpt-3.5-turbo-0125",
"temprature": 123,
"maxTokens": 123
},
"vg_max_messages_history": 123,
"ifKnowsThreshold": 123,
"avatarImageUrl": "<string>",
"headerImageUrl": "<string>",
"bannerImageUrl": "<string>",
"soundEffectUrl": "<string>",
"soundEffectEnabled": true,
"enableQuickFileUpload": true,
"instagramOptions": {
"pageId": "<string>",
"accessToken": "<string>"
},
"translateUserResponse": true,
"starred": true,
"flowise": {
"webhookUrl": "<string>",
"webhookSecret": "<string>"
},
"vfSettings": {
"enableIgnoreUrlPaths": true
},
"vapi": "<any>",
"vapiConfig": {
"syncKbOnSave": true,
"PUBLIC_API_KEY": "<string>",
"PRIVATE_API_KEY": "<string>",
"enableVapiOnWeb": true,
"overrideWithVG": true,
"promptOnWeb": true,
"maxCostMonthly": 123,
"maxMinutesMonthly": 123,
"useVfProject": true,
"syncTools": true
},
"vgOptions": {
"isLlmStudio": true,
"showSources": true,
"lightUiEngine": true,
"legacyKb": true,
"maxChunkSize": 123,
"handoffTimeout": 123
},
"ui": {
"bgImageVisible": true,
"widgetType": "direct-chat",
"enableFixedFeedbackBtns": true,
"voice": {
"question": "<string>",
"continueBtnLabel": "<string>",
"dismissBtnLabel": "<string>"
}
},
"assignedToolsIds": [
"<string>"
],
"tools": [
{
"isDefault": true,
"method": "GET",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"variablesIds": [
"<string>"
],
"agentId": "<string>",
"userId": "<string>",
"backchannellingPhrases": [
"<string>"
],
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
],
"internal": {
"accountCreationConfig": "v2",
"websocketServer": "edge",
"setOnResponse": true,
"enableSetOnLoad": true
},
"disableAutoTranscribeAudio": true,
"instaAgentUsername": "<string>",
"convoTags": [
"<string>"
],
"vfConfig": {
"alwaysEnableCardButtons": true
},
"discord": {
"channelIds": [
"<string>"
],
"webhookUrls": [
"<string>"
]
},
"limits": {
"maxInteractionsPerUserId": 123
},
"tabs": [
"<any>"
],
"kbTags": [
"<string>"
],
"kbTagsDataMap": [
"<any>"
],
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"isGlobal": true,
"toolsIds": [
"<string>"
],
"childrenNodes": [
{
"nodeId": "<string>",
"condition": "<string>"
}
],
"llmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"routerLlmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"toolUseBias": 123,
"autoRerouter": {
"enabled": true,
"level": 123
},
"type": "start",
"rf": "<any>",
"kb": {
"enabled": true,
"maxChunks": 123,
"tags": [
"<string>"
],
"smartSearch": true
},
"preStart": {
"url": "<string>",
"enabled": true
}
}
],
"enableNodes": true,
"advanced": {
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"nodesSettings": {
"appendBeforePrompt": "<string>",
"routerLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"defaultLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"backchannelOnChoosingNodes": true,
"enableUiEngine": true
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
}
}
}'{
"success": true,
"message": "<string>",
"data": {
"title": "<string>",
"description": "<string>",
"ownerID": "<string>",
"theme": "<string>",
"voiceConfig": {
"transcriber": {
"speechConfig": {
"format": "<string>",
"sampleRate": 123
},
"modelId": "<string>",
"patienceFactor": 123,
"language": "<string>",
"provider": "deepgram",
"randomOptions": "<any>",
"internal": {
"inputAudioStream": "<any>",
"debug": true
},
"apiKey": "<string>",
"platformSpecific": {
"deepgram": {
"modelId": "nova-3"
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123
},
"speechGen": {
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarityBoost": 123,
"style": 123,
"useSpeakerBoost": true
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true
}
},
"disabled": true,
"vectorDb": "<any>",
"withRefresh": true,
"agentPlatform": "<any>",
"ID": "<string>",
"storageID": "<string>",
"VF_DIALOGUE_API_KEY": "<string>",
"VF_PROJECT_API_KEY": "<string>",
"VF_PROJECT_ID": "<string>",
"VF_KB_API_KEY": "<string>",
"roundedImageURL": "<string>",
"rectangeImageURL": "<string>",
"messageDelayMS": 123,
"scrollAnimation": true,
"proactiveMessage": "<string>",
"acceptFileUpload": true,
"recordChatHistory": true,
"chatBgURL": "<string>",
"disableSmoothScroll": true,
"isDeployed": true,
"tokensUsage": "<any>",
"maxTokensUsage": "<any>",
"lastModified": 123,
"fontFamily": "<string>",
"branding": "<string>",
"customThemeJSONString": "<string>",
"autoStartWidget": true,
"allTimeTriggers": 123,
"syncBrowser": true,
"delayBeforeSubmit": 123,
"region": "eu",
"listenForUrlChanges": true,
"chatForget": true,
"lang": "<string>",
"enableAudioSupport": true,
"AITranslateTo": "<string>",
"enableAITranslate": true,
"disableNoReplyListener": true,
"disableHumanHandoff": true,
"alwaysShowHandoff": true,
"manualControl": true,
"enableVGHandoff": true,
"enableGeoAnalytics": true,
"fixedHandoffPopup": true,
"buttonsLayout": "horizontal",
"ADVANCED_customCSS": "<string>",
"messagesLimit": 123,
"whatsappToken": "<string>",
"whatsappNumberId": "<string>",
"whatsappBusniessId": "<string>",
"waTestNumber": "<string>",
"waVerifyPassed": true,
"waTestPassed": true,
"webhookUrl": "<string>",
"gcloudPrivateKey": "<string>",
"gcloudClientEmail": "<string>",
"smartInit": true,
"UIhandoffTitle": "<string>",
"UIhandoffSubtitle": "<string>",
"igVerified": true,
"igAccessToken": "<string>",
"showHandoffEvenIfOffline": true,
"customButtonJSON_STRING": "<string>",
"vg_initPrompt": "<string>",
"vg_prompt": "<string>",
"vg_initMessages": [
"<string>"
],
"vg_systemPrompt": "<string>",
"vg_temperature": 123,
"vg_defaultModel": "gpt-3.5-turbo-0125",
"vg_maxTokens": 123,
"vg_kbDefaultDimension": 123,
"vg_kbTopChunks": 123,
"SECRET_API_KEY": "<string>",
"vg_kbCharCount": 123,
"vg_kbDocsNum": 123,
"vg_enableUIEngine": true,
"vg_enableAboutContext": true,
"vg_kb_llm": {
"searchMethod": "smart",
"searchPrompt": "<string>",
"modelId": "gpt-3.5-turbo-0125",
"temprature": 123,
"maxTokens": 123
},
"vg_max_messages_history": 123,
"ifKnowsThreshold": 123,
"avatarImageUrl": "<string>",
"headerImageUrl": "<string>",
"bannerImageUrl": "<string>",
"soundEffectUrl": "<string>",
"soundEffectEnabled": true,
"enableQuickFileUpload": true,
"instagramOptions": {
"pageId": "<string>",
"accessToken": "<string>"
},
"translateUserResponse": true,
"starred": true,
"flowise": {
"webhookUrl": "<string>",
"webhookSecret": "<string>"
},
"vfSettings": {
"enableIgnoreUrlPaths": true
},
"vapi": "<any>",
"vapiConfig": {
"syncKbOnSave": true,
"PUBLIC_API_KEY": "<string>",
"PRIVATE_API_KEY": "<string>",
"enableVapiOnWeb": true,
"overrideWithVG": true,
"promptOnWeb": true,
"maxCostMonthly": 123,
"maxMinutesMonthly": 123,
"useVfProject": true,
"syncTools": true
},
"vgOptions": {
"isLlmStudio": true,
"showSources": true,
"lightUiEngine": true,
"legacyKb": true,
"maxChunkSize": 123,
"handoffTimeout": 123
},
"ui": {
"bgImageVisible": true,
"widgetType": "direct-chat",
"enableFixedFeedbackBtns": true,
"voice": {
"question": "<string>",
"continueBtnLabel": "<string>",
"dismissBtnLabel": "<string>"
}
},
"assignedToolsIds": [
"<string>"
],
"tools": [
{
"isDefault": true,
"method": "GET",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"variablesIds": [
"<string>"
],
"agentId": "<string>",
"userId": "<string>",
"backchannellingPhrases": [
"<string>"
],
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
],
"internal": {
"accountCreationConfig": "v2",
"websocketServer": "edge",
"setOnResponse": true,
"enableSetOnLoad": true
},
"disableAutoTranscribeAudio": true,
"instaAgentUsername": "<string>",
"convoTags": [
"<string>"
],
"vfConfig": {
"alwaysEnableCardButtons": true
},
"discord": {
"channelIds": [
"<string>"
],
"webhookUrls": [
"<string>"
]
},
"limits": {
"maxInteractionsPerUserId": 123
},
"tabs": [
"<any>"
],
"kbTags": [
"<string>"
],
"kbTagsDataMap": [
"<any>"
],
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"isGlobal": true,
"toolsIds": [
"<string>"
],
"childrenNodes": [
{
"nodeId": "<string>",
"condition": "<string>"
}
],
"llmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"routerLlmConfig": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"toolUseBias": 123,
"autoRerouter": {
"enabled": true,
"level": 123
},
"type": "start",
"rf": "<any>",
"kb": {
"enabled": true,
"maxChunks": 123,
"tags": [
"<string>"
],
"smartSearch": true
},
"preStart": {
"url": "<string>",
"enabled": true
}
}
],
"enableNodes": true,
"advanced": {
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"nodesSettings": {
"appendBeforePrompt": "<string>",
"routerLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"defaultLLmOptions": {
"modelId": "gpt-3.5-turbo-0125",
"temperature": 123,
"maxTokens": 123
},
"backchannelOnChoosingNodes": true,
"enableUiEngine": true
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
}
}
}