Get Chatbots

get/api/external/chatbots

Headers

x-api-keystring

Example:15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68

Response

Get Chatbots

Example response

{
  "chatbots": [
    {
      "active": true,
      "created_at": "2025-01-22T04:30:45.790337+00:00",
      "description": "A helpful support assistant",
      "enabled_plugins": null,
      "id": "3317853e-0af2-427d-a56f-351a9587f48f",
      "is_public": false,
      "name": "API Docs Demo Chatbot",
      "organization_id": "123042b2-86e2-4184-a86e-95423d728815",
      "personality_config": {
        "style": "Friendly",
        "tone": "Professional"
      },
      "settings": {
        "greeting": "Hello! How can I assist you today?",
        "isRequestUserInfoEnabled": false,
        "isToolEnabled": true,
        "model": "gpt-4o-mini",
        "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
        "snippet": {
          "header": "Customer Support",
          "logo": "https://example.com/logo.png",
          "name": "Support Assistant",
          "primaryColor": "#4F46E5",
          "secondaryColor": "#10B981",
          "slogan": "How can I help you today?"
        }
      },
      "slug": "api-docs-demo-chatbot",
      "suggestions": null,
      "updated_at": "2025-01-22T04:30:45.790337+00:00",
      "version_id": null,
      "voice_widget_config": null
    }
  ]
}

Changes

Changed in 2 of the 10 revisions of this API.256

Jan 22, 2025b8640ab9f7e034See the full diff
- ●
  the optional response header Keep-Alive removed for the status 200
  optional-response-header-removed
- ●
  removed the optional property chatbots/items/openai_api_key from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbots/items/settings/avatar from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property chatbots/items/enabled_plugins to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property chatbots/items/suggestions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property chatbots/items/version_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property chatbots/items/voice_widget_config to the response with the 200 status
  response-optional-property-added
Jan 22, 20259a74b2d0931e222See the full diff
- ●
  the optional response header CF-RAY removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Cache-Control removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Content-Encoding removed for the status 200
  optional-response-header-removed
- ●
  the optional response header NEL removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Report-To removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Server removed for the status 200
  optional-response-header-removed
- ●
  the optional response header access-control-allow-credentials removed for the status 200
  optional-response-header-removed
- ●
  the optional response header access-control-allow-headers removed for the status 200
  optional-response-header-removed
- ●
  the optional response header access-control-allow-methods removed for the status 200
  optional-response-header-removed
- ●
  the optional response header access-control-allow-origin removed for the status 200
  optional-response-header-removed
- ●
  the optional response header alt-svc removed for the status 200
  optional-response-header-removed
- ●
  the optional response header cf-cache-status removed for the status 200
  optional-response-header-removed
- ●
  the optional response header server-timing removed for the status 200
  optional-response-header-removed
- ●
  the optional response header strict-transport-security removed for the status 200
  optional-response-header-removed
- ●
  the optional response header vary removed for the status 200
  optional-response-header-removed
- ●
  the optional response header x-matched-path removed for the status 200
  optional-response-header-removed
- ●
  the optional response header x-vercel-cache removed for the status 200
  optional-response-header-removed
- ●
  the optional response header x-vercel-id removed for the status 200
  optional-response-header-removed
- ●
  removed the optional property chatbots/items/enabled_plugins from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbots/items/suggestions from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbots/items/version_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbots/items/voice_widget_config from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property chatbots/items/openai_api_key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property chatbots/items/settings/avatar to the response with the 200 status
  response-optional-property-added

Full history