Chatbot

Get User Chatbots

get

Retrieve a list of chatbots available for the specified user, including their models, agents, search types, and other configurations

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Query parameters

phone_numberany ofOptional

The phone number of the provider

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/chatbots

HTTPcURLJavaScriptPython

GET /chatbots HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "chatbots": [
    {
      "id": "chatbot-1",
      "display_name": "Sample Chatbot",
      "description": "This is a sample chatbot",
      "models": [],
      "agents": [],
      "support_pii_anonymization": true,
      "default_pii_anonymization": true,
      "search_types": [],
      "discovery_providers": {},
      "enable_smart_search_integration": false,
      "chat_history_limit": 0,
      "connectors": [],
      "is_question_library": false,
      "question_library": [],
      "question_show_list": [],
      "tenant_id": "uuid",
      "light_logo_url": "url",
      "dark_logo_url": "url",
      "phone_number": "1234567890",
      "use_tenant_logo": false,
      "enable_live_chat": false,
      "show_app_logo": false
    }
  ]
}

Get Chatbot Right-Sidebar Filter

get

Retrieve the right-sidebar filter for a specific chatbot. This filter is fetched from the chatbot's preset.

Path parameters

chatbot_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/chatbots/{chatbot_id}/filters

HTTPcURLJavaScriptPython

GET /chatbots/{chatbot_id}/filters HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "csv_name": "text",
    "label": "text",
    "is_filter": true,
    "is_field_of_interest": true,
    "default": null,
    "placeholder": "text",
    "type": "select",
    "is_range": true,
    "is_multi": true,
    "min_date": "2026-01-13",
    "max_date": "2026-01-13",
    "min": "2026-01-13",
    "max": "2026-01-13",
    "step": 1,
    "options": [
      {
        "label": "text",
        "value": "text"
      }
    ]
  }
]