API Reference
API Documentation
V3
- Get Started
- 📁 Workspaces
- 🤖 Agents
- Calls & Numbers
- 🔨 Tools
- ✖️ Variables
- 👥 Leads
- 🧠 Knowledge Base
- 💬 Conversations
- 🏢 Orgs
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
🤖 Agents
Update Agent
Updates an agent, this route must use the new V3 endpoints.
PATCH
/
agents
/
{id}
Copy
curl --request PATCH \
--url https://eu-gcp-api.vg-stuff.com/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": {
"keywords": [
"<string>"
],
"language": "<string>",
"smart_format": true,
"model": "<string>",
"interim_results": true,
"endpointing": 123,
"no_delay": true
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123,
"inputVoiceEnhancer": true
},
"speechGen": {
"highAudioQuality": true,
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarity_boost": 123,
"use_speaker_boost": true,
"speed": 123,
"style": 123
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"enableLongMessageBackchannelling": true,
"backchannelMessages": [
"<string>"
],
"backchannelInterval": 123,
"wordsReplacements": [
{
"word": "<string>",
"replacement": "<string>"
}
],
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true,
"firstInputChunkUNIXMs": 123,
"firstOutputChunkUNIXMs": 123
}
},
"createdAtUNIX": 123,
"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,
"maxAnnualCreditsUsage": 123,
"maxMonthlyCreditsUsage": 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
},
"conditionData": {
"condition": "<string>"
},
"preStart": {
"url": "<string>",
"enabled": true,
"testConvoIdValue": "<string>"
}
}
],
"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,
"fallbackModelIds": [
"gpt-3.5-turbo-0125"
],
"silenceDetection": {
"enabled": false,
"timeoutSeconds": 60,
"endCallAfterNPhrases": 1
},
"startCallPhrases": [
"<string>"
],
"fillerWordsOnToolUsage": true,
"smartEndpointing": {
"enabled": true,
"waitSeconds": 123,
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
},
"stopSpeakPlan": {
"minWords": 123
},
"callTimeoutSeconds": 123
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
},
"marketplace": {
"enabled": true,
"priceUSD": 123
},
"disableRating": true,
"chatEndMessage": "<string>",
"aiIntroductionMessage": "<string>",
"deployed": true
}
}'
Copy
{
"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": {
"keywords": [
"<string>"
],
"language": "<string>",
"smart_format": true,
"model": "<string>",
"interim_results": true,
"endpointing": 123,
"no_delay": true
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123,
"inputVoiceEnhancer": true
},
"speechGen": {
"highAudioQuality": true,
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarity_boost": 123,
"use_speaker_boost": true,
"speed": 123,
"style": 123
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"enableLongMessageBackchannelling": true,
"backchannelMessages": [
"<string>"
],
"backchannelInterval": 123,
"wordsReplacements": [
{
"word": "<string>",
"replacement": "<string>"
}
],
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true,
"firstInputChunkUNIXMs": 123,
"firstOutputChunkUNIXMs": 123
}
},
"createdAtUNIX": 123,
"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,
"maxAnnualCreditsUsage": 123,
"maxMonthlyCreditsUsage": 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
},
"conditionData": {
"condition": "<string>"
},
"preStart": {
"url": "<string>",
"enabled": true,
"testConvoIdValue": "<string>"
}
}
],
"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,
"fallbackModelIds": [
"gpt-3.5-turbo-0125"
],
"silenceDetection": {
"enabled": false,
"timeoutSeconds": 60,
"endCallAfterNPhrases": 1
},
"startCallPhrases": [
"<string>"
],
"fillerWordsOnToolUsage": true,
"smartEndpointing": {
"enabled": true,
"waitSeconds": 123,
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
},
"stopSpeakPlan": {
"minWords": 123
},
"callTimeoutSeconds": 123
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
},
"marketplace": {
"enabled": true,
"priceUSD": 123
},
"disableRating": true,
"chatEndMessage": "<string>",
"aiIntroductionMessage": "<string>",
"deployed": true
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
The response is of type object
.
The response is of type any
.
Copy
curl --request PATCH \
--url https://eu-gcp-api.vg-stuff.com/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": {
"keywords": [
"<string>"
],
"language": "<string>",
"smart_format": true,
"model": "<string>",
"interim_results": true,
"endpointing": 123,
"no_delay": true
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123,
"inputVoiceEnhancer": true
},
"speechGen": {
"highAudioQuality": true,
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarity_boost": 123,
"use_speaker_boost": true,
"speed": 123,
"style": 123
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"enableLongMessageBackchannelling": true,
"backchannelMessages": [
"<string>"
],
"backchannelInterval": 123,
"wordsReplacements": [
{
"word": "<string>",
"replacement": "<string>"
}
],
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true,
"firstInputChunkUNIXMs": 123,
"firstOutputChunkUNIXMs": 123
}
},
"createdAtUNIX": 123,
"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,
"maxAnnualCreditsUsage": 123,
"maxMonthlyCreditsUsage": 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
},
"conditionData": {
"condition": "<string>"
},
"preStart": {
"url": "<string>",
"enabled": true,
"testConvoIdValue": "<string>"
}
}
],
"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,
"fallbackModelIds": [
"gpt-3.5-turbo-0125"
],
"silenceDetection": {
"enabled": false,
"timeoutSeconds": 60,
"endCallAfterNPhrases": 1
},
"startCallPhrases": [
"<string>"
],
"fillerWordsOnToolUsage": true,
"smartEndpointing": {
"enabled": true,
"waitSeconds": 123,
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
},
"stopSpeakPlan": {
"minWords": 123
},
"callTimeoutSeconds": 123
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
},
"marketplace": {
"enabled": true,
"priceUSD": 123
},
"disableRating": true,
"chatEndMessage": "<string>",
"aiIntroductionMessage": "<string>",
"deployed": true
}
}'
Copy
{
"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": {
"keywords": [
"<string>"
],
"language": "<string>",
"smart_format": true,
"model": "<string>",
"interim_results": true,
"endpointing": 123,
"no_delay": true
},
"assemblyai": {
"modelId": "<string>"
}
},
"utteranceThreshold": 123,
"inputVoiceEnhancer": true
},
"speechGen": {
"highAudioQuality": true,
"provider": "elevenlabs",
"modelId": "<string>",
"voiceId": "<string>",
"apiKey": "<string>",
"region": "<string>",
"backgroundNoise": "restaurant",
"punctuationBreaks": [
"<string>"
],
"platformSpecific": {
"elevenLabs": {
"stability": 123,
"similarity_boost": 123,
"use_speaker_boost": true,
"speed": 123,
"style": 123
},
"playht": {
"voiceId": "<string>"
}
},
"backChannelling": true,
"language": "<string>",
"enableLongMessageBackchannelling": true,
"backchannelMessages": [
"<string>"
],
"backchannelInterval": 123,
"wordsReplacements": [
{
"word": "<string>",
"replacement": "<string>"
}
],
"internal": {
"inputTextStream": "<any>",
"audioConfig": {
"format": "<string>",
"sampleRate": 123,
"channels": 123
},
"emitOnComplete": true
}
},
"config": {
"recordAudio": true,
"backgroundNoise": "restaurant",
"enableWebCalling": true,
"firstInputChunkUNIXMs": 123,
"firstOutputChunkUNIXMs": 123
}
},
"createdAtUNIX": 123,
"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,
"maxAnnualCreditsUsage": 123,
"maxMonthlyCreditsUsage": 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
},
"conditionData": {
"condition": "<string>"
},
"preStart": {
"url": "<string>",
"enabled": true,
"testConvoIdValue": "<string>"
}
}
],
"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,
"fallbackModelIds": [
"gpt-3.5-turbo-0125"
],
"silenceDetection": {
"enabled": false,
"timeoutSeconds": 60,
"endCallAfterNPhrases": 1
},
"startCallPhrases": [
"<string>"
],
"fillerWordsOnToolUsage": true,
"smartEndpointing": {
"enabled": true,
"waitSeconds": 123,
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
},
"stopSpeakPlan": {
"minWords": 123
},
"callTimeoutSeconds": 123
},
"id": "<string>",
"enableFallback": true,
"fallbackSettings": {
"model": "gpt-3.5-turbo-0125",
"creditThreshold": 123
},
"marketplace": {
"enabled": true,
"priceUSD": 123
},
"disableRating": true,
"chatEndMessage": "<string>",
"aiIntroductionMessage": "<string>",
"deployed": true
}
}
Assistant
Responses are generated using AI and may contain mistakes.