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
Agents
Create/Edit Agent
Edits/Creates a new agent in the system
POST
/
v2
/
agents
/
{agent_id}
curl --request POST \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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
}'
{
"success": true,
"message": "Agent created successfully",
"data": {
"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
}
}
Authorizations
Agent/Workspace secret API key as bearer token.
Path Parameters
The ID of the agent to create/edit
Body
application/json
New agent data to create/edit
The body is of type object
.
Response
200
application/json
Agent created
The response is of type object
.
curl --request POST \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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
}'
{
"success": true,
"message": "Agent created successfully",
"data": {
"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
}
}