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
💼 Agency
Get Agency
Returns the agency associated with the workspace
GET
/
v2
/
agencies
curl --request GET \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/agencies \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "Agencies retrieved successfully",
"data": {
"ID": "<string>",
"userId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": true,
"isVerifiedCustomDomain": true,
"withVGBranding": true,
"themeVariant": "default",
"themeColorUsage": "gradient",
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"secret": "<string>",
"OPENAI_API_KEY": "<string>",
"OPENAI_DEFAULT_MODEL": "gpt-3.5-turbo",
"address": "<string>",
"customCSS": "<string>",
"enableHumanHandoff": true,
"resendEmailDomain": "<string>",
"resendEmailDomainId": "<string>",
"resendEmailDomainStatus": "not_started",
"resendEmailDomainRecords_JSON_STRING": "<string>"
}
}
Authorizations
Workspace secret API key, found in the workspace settings page (top left).
Response
200
application/json
Agency retrieved
The response is of type object
.
curl --request GET \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/agencies \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "Agencies retrieved successfully",
"data": {
"ID": "<string>",
"userId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": true,
"isVerifiedCustomDomain": true,
"withVGBranding": true,
"themeVariant": "default",
"themeColorUsage": "gradient",
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"secret": "<string>",
"OPENAI_API_KEY": "<string>",
"OPENAI_DEFAULT_MODEL": "gpt-3.5-turbo",
"address": "<string>",
"customCSS": "<string>",
"enableHumanHandoff": true,
"resendEmailDomain": "<string>",
"resendEmailDomainId": "<string>",
"resendEmailDomainStatus": "not_started",
"resendEmailDomainRecords_JSON_STRING": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.