GET /embed-config

Endpoint

GET /embed-config?botId=<bot-id>

Authentication: None required — this is a public endpoint.

Query Parameters

Parameter	Type	Required	Description
`botId`	`string`	Yes	The agent ID

Response (200 OK)

{
  "botName": "Acme Assistant",
  "welcomeMessage": "Hi! How can Acme Assistant help you today?",
  "runtimeEndpoint": "https://api.getilana.ai",
  "cdnUrl": "https://cdn.getilana.ai",
  "poweredByRequired": true,
  "theme": {
    "primaryColor": "#0ea5e9",
    "backgroundColor": "#18181b"
  },
  "suggestedQuestions": [
    { "id": "q1", "text": "What plans do you offer?", "order": 0 },
    { "id": "q2", "text": "How do I get started?", "order": 1 }
  ],
  "suggestedQuestionsStyle": "pills",
  "template": {
    "id": "chat",
    "bundleUrl": "https://cdn.getilana.ai/templates/chat.js",
    "options": {}
  }
}

Field	Type	Description
`botName`	`string`	Display name of the agent
`welcomeMessage`	`string`	Welcome message (with `{botName}` substituted)
`runtimeEndpoint`	`string`	Runtime API URL for the widget to use
`cdnUrl`	`string`	CDN base URL for assets
`poweredByRequired`	`boolean`	Whether "Powered by Ilana" must be shown
`theme`	`WidgetTheme \| undefined`	Theme configuration set in admin portal
`suggestedQuestions`	`SuggestedQuestion[]`	Pre-configured questions to show in the widget
`suggestedQuestionsStyle`	`string`	Display style: `'pills'` or `'message_box'`
`template`	`object \| undefined`	Custom template configuration

SuggestedQuestion

Field	Type	Description
`id`	`string`	Question identifier
`text`	`string`	Question display text
`order`	`number`	Display order (ascending)

template

Field	Type	Description
`id`	`string`	Template ID (e.g., `'chat'`, `'demo-search'`)
`bundleUrl`	`string`	URL to the template's JavaScript bundle
`options`	`object \| undefined`	Template-specific configuration options

Variable Substitution

The welcomeMessage field supports the {botName} variable, which is automatically replaced with the agent's name before being returned.

Example

curl "https://api.getilana.ai/embed-config?botId=bot-abc-123"

Error Responses

Status	Code	Cause
400	`INVALID_REQUEST`	Missing `botId` query parameter
404	`NOT_FOUND`	Bot not found or bot is disabled

GET /embed-config

On this page