POST
/
v2
/
agents
/
{agent_id}

Authorizations

Authorization
string
header
required

Agent/Workspace secret API key as bearer token.

Path Parameters

agent_id
string
required

The ID of the agent to create/edit

Body

application/json
agentPlatform
enum<string>
required

Platform of the Agent

Available options:
vf,
vg
title
string
required

Agent title/name

ADVANCED_customCSS
string

(Advanced) Custom CSS for the web widget

alwaysShowHandoff
boolean

Always show handoff popup even if no agents are online

autoStartWidget
boolean

Autostart the widget on page load (Consumes an interaction for VF agents)

avatarImageUrl
string

Web widget chat avatar image url

bannerImageUrl
string

Web widget chat banner image url

branding
string

Branding text under the chatbox

buttonsLayout
enum<string>

Layout of the buttons in the chatbox

Available options:
horizontal,
vertical
chatBgURL
string

Chatbox background image

chatForget
boolean

Forget chathistory on widget close

customThemeJSONString
object

MUST JSON.stringify() this object before passing it to the API.

Custom theme object for the agent

description
string

Agent description

disableNoReplyListener
boolean

VF agents specific -- Disable no reply listener

disableSmoothScroll
boolean

Disable scroll on new messages

enableAITranslate
boolean

VF agents specific -- Enable AI translation of the response coming from VF

enableAudioSupport
boolean

Enable Mic button for voice input

enableQuickFileUpload
boolean

Enable quick upload button for web widget

fixedHandoffPopup
boolean

Make the handoff popup fixed instead of disappearing on scroll

fontFamily
string

Google font family name Browse fonts

gcloudClientEmail
string

Google chat integration -- Service account client_email for sending messages

gcloudPrivateKey
string

Google chat integration -- Service account private_key for sending messages

headerImageUrl
string

Web widget chat header image url

lang
string

Language of the agent (ISO 639-1), Learn more

listenForUrlChanges
boolean

VF agents specific -- Listen for URL changes and send an intent to Voiceflow when the URL changes

messageDelayMS
number

Delay between messages in milliseconds

proactiveMessage
string

Popup proactive message

recordChatHistory
boolean

Record chat history on VG dashboard or not

roundedImageURL
string

Widget popup launch image

SECRET_API_KEY
string

Agent secret API key to control kb, conversations, etc

showHandoffEvenIfOffline
boolean

Always show handoff popup even if no agents are online

smartInit
boolean

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.

theme
string

Predefined themes: 'blue-light' | 'purple-light' | 'blue-dark' | 'purple-dark' | 'custom-light' | 'custom-dark' // custom themes used along customThemeJSONString

UIhandoffdescription
string

Widget handoff title

UIhandoffSubdescription
string

Widget handoff subtitle

VF_DIALOGUE_API_KEY
string

For VF agents only -- the API key for the agent

VF_PROJECT_API_KEY
string

For VF agents only -- the Project API key

vg_defaultModel
enum<string>

model_id to use to power the agent

Available options:
gpt-3.5-turbo-0125,
gpt-4-1106-preview,
llama2-70b-4096,
mixtral-8x7b-32768,
gemma-7b-it
vg_enableUIEngine
boolean

Enable or disable the AI UI engine for the agent (Makes the AI generate UI elements on its on for the web widget)

vg_initMessages
string[]

VG agents specific -- Array of strings for initial messages

vg_kbDefaultDimension
number

(Advanced) Dimensions of the vector store for the agent

vg_kbTopChunks
number

(Advanced) Max chunks retrieved as context from the vector store for the agent

vg_maxTokens
number

Max tokens for the LLM to generate per interaction (message to the AI)

vg_systemPrompt
string

VG agents specific -- prompt for the agent

vg_temperature
number

Temperature of the LLM

webhookUrl
string

Discord webhook URL

whatsappBusniessId
string

WA Business ID connected to the agent

whatsappNumberId
string

WA number_id connected to the agent

whatsappToken
string

WA access token for sending messages

Response

200 - application/json
data
object
message
string
success
boolean