Skip to main content
GET
/
api
/
v1
/
appearance
/
{id}
/
Get appearance configuration
curl --request GET \
  --url https://api.camelai.com/api/v1/appearance/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "theme_mode": "light",
  "start_message": "<string>",
  "recommendations": "<any>",
  "response_mode": "full",
  "show_sidebar": true,
  "custom_css_vars": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified": "2023-11-07T05:31:56Z",
  "is_default": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer scheme

Path Parameters

​
id
string
required

Response

200 - application/json

Serializer for OrgAppearanceConfig model.

​
id
integer
required
​
name
string
required

Name of this appearance theme

Maximum length: 100
​
custom_css_vars
string
required
​
created_at
string<date-time>
required
​
last_modified
string<date-time>
required
​
is_default
string
required
​
theme_mode
enum<string>

Controls the available theme options for the organization's chat view

  • light - Light
  • dark - Dark
  • both - Both (User Choice)
Available options:
light,
dark,
both
​
start_message
string

Start message displayed when the chat interface opens

Maximum length: 120
​
recommendations
any

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

​
response_mode
enum<string>

Response mode for the chat interface - full includes advanced features like code execution

  • full - Full
  • basic - Basic
Available options:
full,
basic
​
show_sidebar
boolean

Toggle visibility of the chat sidebar in the iframe.