API Documentation
V3
- Get Started
- Workspaces
- Agents
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
Configure State
Configure the chat history state of the conversation and the associated metadata (name, email, etc)
curl --request POST \
--url https://eu-vg-edge.moeaymandev.workers.dev/agents/{agent_id}/interact/{user_id}/state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"turns": [
{
"from": "<string>",
"messages": [
{
"from": "human",
"type": "launch",
"item": {},
"delay": 123,
"ts": 123
}
]
}
],
"delete": {
"mids": [
"<string>"
]
},
"metadata": {
"ID": "<string>",
"userID": "<string>",
"userName": "<string>",
"userEmail": "jsmith@example.com",
"userImage": "<string>",
"userPhone": "<string>",
"userBrowser": "<string>",
"userProfilePic": "<string>",
"origin": "web-chat",
"messagesNum": 123,
"interactionsNum": 123,
"ts": 123,
"tags": [
"<string>"
],
"convoTimeSeconds": 123,
"firstMessageTS": 123,
"lastMessageTS": 123,
"userPlatform": "<string>",
"state": "requested_chat",
"chatAssignedTo": "<string>",
"lastModified": 123,
"sessionsNum": 123
}
}'{
"platformName": "vf",
"chatState": {},
"actionMessages": [
"<any>"
],
"turns": [
{
"from": "bot",
"messages": {
"from": "human",
"type": "launch",
"item": {},
"delay": 123,
"ts": 123
},
"ts": 123
}
],
"success": true,
"appError": "<string>",
"message": "<string>",
"agentData": {
"agentPlatform": "vf",
"title": "<string>",
"description": "<string>",
"VF_DIALOGUE_API_KEY": "<string>",
"VF_PROJECT_API_KEY": "<string>",
"theme": "<string>",
"customThemeJSONString": {
"themeType": "dark",
"primary": "<string>",
"nineColorPallet": [
[
123
]
]
},
"roundedImageURL": "<string>",
"avatarImageUrl": "<string>",
"headerImageUrl": "<string>",
"bannerImageUrl": "<string>",
"chatBgURL": "<string>",
"fontFamily": "<string>",
"branding": "<string>",
"lang": "<string>",
"UIhandoffdescription": "<string>",
"UIhandoffSubdescription": "<string>",
"buttonsLayout": "horizontal",
"ADVANCED_customCSS": "<string>",
"whatsappToken": "<string>",
"whatsappNumberId": "<string>",
"whatsappBusniessId": "<string>",
"webhookUrl": "<string>",
"gcloudPrivateKey": "<string>",
"gcloudClientEmail": "<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,
"vg_enableUIEngine": true,
"SECRET_API_KEY": "<string>",
"messageDelayMS": 123,
"proactiveMessage": "<string>",
"recordChatHistory": true,
"disableSmoothScroll": true,
"autoStartWidget": true,
"listenForUrlChanges": true,
"chatForget": true,
"enableAudioSupport": true,
"enableAITranslate": true,
"disableNoReplyListener": true,
"alwaysShowHandoff": true,
"fixedHandoffPopup": true,
"smartInit": true,
"showHandoffEvenIfOffline": true,
"enableQuickFileUpload": true
},
"origin": "web-chat",
"userID": "<string>",
"agentID": "<string>",
"oldTurns": [
{
"from": "bot",
"messages": {
"from": "human",
"type": "launch",
"item": {},
"delay": 123,
"ts": 123
},
"ts": 123
}
]
}Authorizations
Agent/Workspace secret API key as bearer token.
Path Parameters
The ID of the agent to interact with
The ID of the user to interact with
Body
Completely change the entire conversation state. (optional)
Sender of the turn.
Messages exchanged in this turn.
Sender of the message.
human, bot Type of the message.
launch, text, choice, MultiSelect, cardV2, carousel, visual, GetBrowserData, Embed, iFrame, FileUpload, GoogleForm, EmailForm, SetConvoData, VoiceNote, SetRuntime, no-reply, VGVF_Channel, VFVG_Channel, VG_Response, knowledgeBase, jsx, info:default, info:success, info:danger, info:primary, end Additional data specific to the message type.
Timestamp of the message.
Delay in milliseconds before sending the message.
Messages to delete with the provided ids. (optional)
Message IDs to delete.
Metadata related to the conversation transcript.
ID of the conversation.
User ID.
User's name.
User's email address.
URL to user's profile image.
User's phone number.
User's browser information.
URL to user's profile picture.
Channel origin of the message.
web-chat, whatsapp, discord, gb-chat Number of messages in the conversation.
Number of interactions in the conversation.
Timestamp of the conversation.
Tags associated with the conversation.
Duration of the conversation in seconds.
Timestamp of the first message.
Timestamp of the last message.
User's platform (e.g., mobile, desktop).
Type of action to perform, launch type doesn't require a payload
requested_chat, human-chatting, ai-chatting, ended_chat ID of the human agent (client_id) assigned to the conversation.
Timestamp of the last modification.
Number of sessions in the conversation.
Response
Name of the platform (virtual flow or TIXAE Agents).
vf, vg Indicates if the interaction was successful.
General message.
State of the chat.
Messages related to actions.
Turns in the conversation.
The sender of the turn, whether from a bot or a human.
bot, human Messages exchanged in this turn.
Sender of the message.
human, bot Type of the message.
launch, text, choice, MultiSelect, cardV2, carousel, visual, GetBrowserData, Embed, iFrame, FileUpload, GoogleForm, EmailForm, SetConvoData, VoiceNote, SetRuntime, no-reply, VGVF_Channel, VFVG_Channel, VG_Response, knowledgeBase, jsx, info:default, info:success, info:danger, info:primary, end Additional data specific to the message type.
Timestamp of the message.
Delay in milliseconds before sending the message.
Timestamp of the turn.
Error message related to the app.
Data related to the agent in the conversation.
Platform of the Agent
vf, vg Agent title/name
Agent description
For VF agents only -- the API key for the agent
For VF agents only -- the Project API key
Predefined themes: 'blue-light' | 'purple-light' | 'blue-dark' | 'purple-dark' | 'custom-light' | 'custom-dark' // custom themes used along customThemeJSONString
MUST JSON.stringify() this object before passing it to the API.
Custom theme object for the agent
Theme type
dark, light Primary hex color for the theme, example: '#000000'
Array length of 9 where every item is an array of HSL values: [50, 50, 50]
Widget popup launch image
Web widget chat avatar image url
Web widget chat header image url
Web widget chat banner image url
Chatbox background image
Google font family name Browse fonts
Branding text under the chatbox
Language of the agent (ISO 639-1), Learn more
Widget handoff title
Widget handoff subtitle
Layout of the buttons in the chatbox
horizontal, vertical (Advanced) Custom CSS for the web widget
WA access token for sending messages
WA number_id connected to the agent
WA Business ID connected to the agent
Discord webhook URL
Google chat integration -- Service account private_key for sending messages
Google chat integration -- Service account client_email for sending messages
VG agents specific -- Array of strings for initial messages
VG agents specific -- prompt for the agent
Temperature of the LLM
model_id to use to power the agent
gpt-3.5-turbo-0125, gpt-4-1106-preview, llama2-70b-4096, mixtral-8x7b-32768, gemma-7b-it Max tokens for the LLM to generate per interaction (message to the AI)
(Advanced) Dimensions of the vector store for the agent
(Advanced) Max chunks retrieved as context from the vector store for the agent
Enable or disable the AI UI engine for the agent (Makes the AI generate UI elements on its on for the web widget)
Agent secret API key to control kb, conversations, etc
Delay between messages in milliseconds
Popup proactive message
Record chat history on VG dashboard or not
Disable scroll on new messages
Autostart the widget on page load (Consumes an interaction for VF agents)
VF agents specific -- Listen for URL changes and send an intent to Voiceflow when the URL changes
Forget chathistory on widget close
Enable Mic button for voice input
VF agents specific -- Enable AI translation of the response coming from VF
VF agents specific -- Disable no reply listener
Always show handoff popup even if no agents are online
Make the handoff popup fixed instead of disappearing on scroll
VF agents specific -- Make the AI reply to the first message on channels like WA, discord, etc by sending 2 requests on initilization instead of launching the flow only.
Always show handoff popup even if no agents are online
Enable quick upload button for web widget
Origin of the message.
web-chat, whatsapp, discord, gb-chat User/Conversation ID.
Agent ID.
Previously recorded turns in the conversation.
The sender of the turn, whether from a bot or a human.
bot, human Messages exchanged in this turn.
Sender of the message.
human, bot Type of the message.
launch, text, choice, MultiSelect, cardV2, carousel, visual, GetBrowserData, Embed, iFrame, FileUpload, GoogleForm, EmailForm, SetConvoData, VoiceNote, SetRuntime, no-reply, VGVF_Channel, VFVG_Channel, VG_Response, knowledgeBase, jsx, info:default, info:success, info:danger, info:primary, end Additional data specific to the message type.
Timestamp of the message.
Delay in milliseconds before sending the message.
Timestamp of the turn.
curl --request POST \
--url https://eu-vg-edge.moeaymandev.workers.dev/agents/{agent_id}/interact/{user_id}/state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"turns": [
{
"from": "<string>",
"messages": [
{
"from": "human",
"type": "launch",
"item": {},
"delay": 123,
"ts": 123
}
]
}
],
"delete": {
"mids": [
"<string>"
]
},
"metadata": {
"ID": "<string>",
"userID": "<string>",
"userName": "<string>",
"userEmail": "jsmith@example.com",
"userImage": "<string>",
"userPhone": "<string>",
"userBrowser": "<string>",
"userProfilePic": "<string>",
"origin": "web-chat",
"messagesNum": 123,
"interactionsNum": 123,
"ts": 123,
"tags": [
"<string>"
],
"convoTimeSeconds": 123,
"firstMessageTS": 123,
"lastMessageTS": 123,
"userPlatform": "<string>",
"state": "requested_chat",
"chatAssignedTo": "<string>",
"lastModified": 123,
"sessionsNum": 123
}
}'{
"platformName": "vf",
"chatState": {},
"actionMessages": [
"<any>"
],
"turns": [
{
"from": "bot",
"messages": {
"from": "human",
"type": "launch",
"item": {},
"delay": 123,
"ts": 123
},
"ts": 123
}
],
"success": true,
"appError": "<string>",
"message": "<string>",
"agentData": {
"agentPlatform": "vf",
"title": "<string>",
"description": "<string>",
"VF_DIALOGUE_API_KEY": "<string>",
"VF_PROJECT_API_KEY": "<string>",
"theme": "<string>",
"customThemeJSONString": {
"themeType": "dark",
"primary": "<string>",
"nineColorPallet": [
[
123
]
]
},
"roundedImageURL": "<string>",
"avatarImageUrl": "<string>",
"headerImageUrl": "<string>",
"bannerImageUrl": "<string>",
"chatBgURL": "<string>",
"fontFamily": "<string>",
"branding": "<string>",
"lang": "<string>",
"UIhandoffdescription": "<string>",
"UIhandoffSubdescription": "<string>",
"buttonsLayout": "horizontal",
"ADVANCED_customCSS": "<string>",
"whatsappToken": "<string>",
"whatsappNumberId": "<string>",
"whatsappBusniessId": "<string>",
"webhookUrl": "<string>",
"gcloudPrivateKey": "<string>",
"gcloudClientEmail": "<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,
"vg_enableUIEngine": true,
"SECRET_API_KEY": "<string>",
"messageDelayMS": 123,
"proactiveMessage": "<string>",
"recordChatHistory": true,
"disableSmoothScroll": true,
"autoStartWidget": true,
"listenForUrlChanges": true,
"chatForget": true,
"enableAudioSupport": true,
"enableAITranslate": true,
"disableNoReplyListener": true,
"alwaysShowHandoff": true,
"fixedHandoffPopup": true,
"smartInit": true,
"showHandoffEvenIfOffline": true,
"enableQuickFileUpload": true
},
"origin": "web-chat",
"userID": "<string>",
"agentID": "<string>",
"oldTurns": [
{
"from": "bot",
"messages": {
"from": "human",
"type": "launch",
"item": {},
"delay": 123,
"ts": 123
},
"ts": 123
}
]
}