Get Chatbot Details

get/api/external/chatbot/{chatbotId}

Headers

x-api-keystring

Example:15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68

Response

Example

Example response

{
  "chatbot": {
    "active": true,
    "created_at": "2025-01-22T04:30:45.790337+00:00",
    "description": "A helpful support assistant",
    "id": "3317853e-0af2-427d-a56f-351a9587f48f",
    "is_public": true,
    "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?",
      "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",
    "updated_at": "2025-01-22T04:30:45.790337+00:00"
  }
}

Changes

Changed in 3 of the 10 revisions of this API.1302

Jan 22, 2025ed6a626deb6d1See the full diff
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
Jan 22, 2025b8640ab9f7e014See the full diff
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ●
  the optional response header Connection removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Date removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Keep-Alive removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Transfer-Encoding removed for the status 200
  optional-response-header-removed
Jan 22, 20259a74b2d0931e261See 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 chatbot/docs_metadata from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/enabled_plugins from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/managers from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/migrated_data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/suggestions from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/v1_chatbot_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/version_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property chatbot/voice_widget_config from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property chatbot/settings/avatar to the response with the 200 status
  response-optional-property-added

Full history