appearance

List appearance configurations

Get all appearance configurations for your organization.

GET /api/v1/appearance/

Headers

Authorizationrequired

any - API key authentication using Bearer scheme

Response

idrequired

integer

namerequired

string - Name of this appearance theme

theme_mode

enum<string>: light, dark, both - Controls the available theme options for the organization's chat view * `light` - Light * `dark` - Dark * `both` - Both (User Choice)

start_message

string - Start message displayed when the chat interface opens

recommendations

any - List of recommended questions to show on the start screen (max 500, up to 280 chars each)

response_mode

enum<string>: full, basic - Response mode for the chat interface - full includes advanced features like code execution * `full` - Full * `basic` - Basic

show_sidebar

boolean - Toggle visibility of the chat sidebar in the iframe.

show_dashboards

boolean - Toggle visibility of the dashboards tab in the iframe.

custom_css_varsrequired

string

created_atrequired

string<date-time>

last_modifiedrequired

string<date-time>

is_defaultrequired

string

cURL

curl --request GET \
  --url https://api.camelai.com/api/v1/appearance/ \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": 123,
    "name": "Production",
    "theme_mode": "light",
    "start_message": "Ask a question about your data",
    "recommendations": [
      "What changed in revenue last month?"
    ],
    "response_mode": "full",
    "show_sidebar": true,
    "show_dashboards": true,
    "custom_css_vars": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "last_modified": "2023-11-07T05:31:56Z",
    "is_default": "<string>"
  }
]