GET
/
v2
/
agents
/
{agent_id}
curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'
{
  "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

​
Authorization
string
header
required

Agent/Workspace secret API key as bearer token.

Path Parameters

​
agent_id
string
required

The ID of the agent to retrieve

Response

200
application/json

Agent retrieved

The response is of type object.