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
Chat Interact
Interact with an agent (VF/VG)
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
Messages to append to the conversation.
Sender of the message.
human
, bot
Additional data specific to the message type.
Timestamp of the message.
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
Delay in milliseconds before sending the message.
Channel to send message through.
web-chat
, whatsapp
, discord
, gb-chat
Metadata related to the conversation transcript.
ID of the human agent (client_id) assigned to the conversation.
Duration of the conversation in seconds.
Timestamp of the first message.
ID of the conversation.
Number of interactions in the conversation.
Timestamp of the last message.
Timestamp of the last modification.
Number of messages in the conversation.
Channel origin of the message.
web-chat
, whatsapp
, discord
, gb-chat
Number of sessions in the conversation.
Type of action to perform, launch type doesn't require a payload
requested_chat
, human-chatting
, ai-chatting
, ended_chat
Tags associated with the conversation.
Timestamp of the conversation.
User's browser information.
User's email address.
User ID.
URL to user's profile image.
User's name.
User's phone number.
User's platform (e.g., mobile, desktop).
URL to user's profile picture.
Variables to inject to VF.
Response
General message.
Name of the platform (virtual flow or TIXAE Agents).
vf
, vg
Indicates if the interaction was successful.
Messages related to actions.
Data related to the agent in the conversation.
Platform of the Agent
vf
, vg
Agent title/name
(Advanced) Custom CSS for the web widget
Always show handoff popup even if no agents are online
Autostart the widget on page load (Consumes an interaction for VF agents)
Web widget chat avatar image url
Web widget chat banner image url
Branding text under the chatbox
Layout of the buttons in the chatbox
horizontal
, vertical
Chatbox background image
Forget chathistory on widget close
MUST JSON.stringify() this object before passing it to the API.
Custom theme object for the agent
Array length of 9 where every item is an array of HSL values: [50, 50, 50]
Primary hex color for the theme, example: '#000000'
Theme type
dark
, light
Agent description
VF agents specific -- Disable no reply listener
Disable scroll on new messages
VF agents specific -- Enable AI translation of the response coming from VF
Enable Mic button for voice input
Enable quick upload button for web widget
Make the handoff popup fixed instead of disappearing on scroll
Google font family name Browse fonts
Google chat integration -- Service account client_email for sending messages
Google chat integration -- Service account private_key for sending messages
Web widget chat header image url
Language of the agent (ISO 639-1), Learn more
VF agents specific -- Listen for URL changes and send an intent to Voiceflow when the URL changes
Delay between messages in milliseconds
Popup proactive message
Record chat history on VG dashboard or not
Widget popup launch image
Agent secret API key to control kb, conversations, etc
Always show handoff popup even if no agents are online
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.
Predefined themes: 'blue-light' | 'purple-light' | 'blue-dark' | 'purple-dark' | 'custom-light' | 'custom-dark' // custom themes used along customThemeJSONString
Widget handoff title
Widget handoff subtitle
For VF agents only -- the API key for the agent
For VF agents only -- the Project API key
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
Enable or disable the AI UI engine for the agent (Makes the AI generate UI elements on its on for the web widget)
VG agents specific -- Array of strings for initial messages
(Advanced) Dimensions of the vector store for the agent
(Advanced) Max chunks retrieved as context from the vector store for the agent
Max tokens for the LLM to generate per interaction (message to the AI)
VG agents specific -- prompt for the agent
Temperature of the LLM
Discord webhook URL
WA Business ID connected to the agent
WA number_id connected to the agent
WA access token for sending messages
Agent ID.
Error message related to the app.
State of the chat.
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
Additional data specific to the message type.
Timestamp of the message.
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
Delay in milliseconds before sending the message.
Timestamp of the turn.
Origin of the message.
web-chat
, whatsapp
, discord
, gb-chat
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
Additional data specific to the message type.
Timestamp of the message.
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
Delay in milliseconds before sending the message.
Timestamp of the turn.
User/Conversation ID.