AI Widget

Public AI Widget config for an app

Public, unauthenticated endpoint the embedded widget calls at load, before it draws the launcher. Returns the appearance the App's admins saved with PUT /v2/apps/{appId}/widget/appearance.

An unknown or inactive App returns an empty appearance rather than an error, so the endpoint does not reveal which App ids exist. Everything it returns is already public on any page that carries the widget snippet.

Responses carry Cache-Control: public, max-age=60, so a change can take a minute to reach visitors. Rate-limited per IP (default 300 requests / minute).

get/v2/widget/config

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/widget/config
  • Auth: none required

Query parameters

appIdstring required

The Ethora App _id (24 hex characters) whose widget is loading.

Response 

{
  ok: true,
  appearance: { [attribute: string]: string }   // e.g. { 'data-primary-color': '#0052cc' }, {} when none
}

Changes

No recorded changes to this operation across all 1 revision of this API.