Bootstrap the widget on a visitor's page

GET

widget

bootstrap

// Runs on your website. The widget key is public and belongs in page source.
const MITHUNAI_API = `${MITHUNAI_URL}/arukz/api/v1`
const WIDGET_KEY = 'arukz_wk_8d0f5a2e-3c41-4b7a-9e6d-1f2a3b4c5d6e'

const response = await fetch(`${MITHUNAI_API}/widget/bootstrap`, {
  headers: { 'X-ARUKZ-Widget-Key': WIDGET_KEY },
})
const { status, brand } = await response.json()
console.log(status, brand.identity?.productName)

curl --request GET "$MITHUNAI_URL/arukz/api/v1/widget/bootstrap" \
  --header "X-ARUKZ-Widget-Key: arukz_wk_8d0f5a2e-3c41-4b7a-9e6d-1f2a3b4c5d6e" \
  --header "Origin: https://docs.example.com"

{
  "status": "active",
  "brand": {
    "identity": { "productName": "Example Docs Assistant", "companyName": "Example Inc." },
    "assets": { "logoMark": "https://docs.example.com/static/logo-mark.svg" },
    "theme": {
      "colors": { "light": { "brand": "#0F6E56", "brandContrast": "#FFFFFF" } },
      "modeDefault": "system"
    },
    "surfaces": { "widget": { "showBranding": true } }
  }
}

{ "code": "authentication_error", "message": "Authentication is required." }

{ "code": "authorization_error", "message": "This widget may not be embedded from that origin." }

{ "code": "rate_limit_exceeded", "message": "Too many requests. Please retry later." }

Call this from the visitor’s browser when your page loads, before you render the widget launcher. It does not take an API key or a console session. It takes the embed’s public widget key in the X-ARUKZ-Widget-Key header, and the browser’s Origin must be allowed by both the deployment’s allowed_origins and the platform-wide widget allowlist. See Website widget. A 200 is the whole answer: it proves the key names a live deployment, the page’s origin is permitted and the organization is active. status is always active. The response deliberately says nothing about the organization, the assistant or the deployment’s name. brand carries your organization’s public brand overrides so the widget can render in your colours without a custom build. It is sparse: it contains only the fields your organization has set, and is {} when none are. Documentation, support and legal links are never included. See Branding. When a request is refused, the response carries no Access-Control-Allow-Origin header. In a cross-origin browser request, fetch therefore rejects with a network error instead of exposing the error body. An unknown, malformed, revoked or expired widget key all return the same 401.

The deployment’s public widget key, arukz_wk_…. An arukz_sk_ API key is not accepted here.

string

required

Set by the browser. It must exactly match an origin allowed for this deployment. When you call from outside a browser, set it yourself.

Response

string

required

Always active.

object

required

Your organization’s public brand overrides, in camelCase. Every section and field is optional.

Show properties

object

productName, productShortName, companyName, companyLegalName, tagline.

object

logoLight, logoDark, logoMark, favicon, ogImage.

object

colors (with light and dark palettes), typography (fontFamilySans, fontFamilyMono, baseSizePx), shape (radiusSm, radiusMd, radiusLg, radiusXl) and modeDefault (light, dark or system).

object

widget (showBranding) and console (showLogo, showPoweredBy).

// Runs on your website. The widget key is public and belongs in page source.
const MITHUNAI_API = `${MITHUNAI_URL}/arukz/api/v1`
const WIDGET_KEY = 'arukz_wk_8d0f5a2e-3c41-4b7a-9e6d-1f2a3b4c5d6e'

const response = await fetch(`${MITHUNAI_API}/widget/bootstrap`, {
  headers: { 'X-ARUKZ-Widget-Key': WIDGET_KEY },
})
const { status, brand } = await response.json()
console.log(status, brand.identity?.productName)

curl --request GET "$MITHUNAI_URL/arukz/api/v1/widget/bootstrap" \
  --header "X-ARUKZ-Widget-Key: arukz_wk_8d0f5a2e-3c41-4b7a-9e6d-1f2a3b4c5d6e" \
  --header "Origin: https://docs.example.com"

{
  "status": "active",
  "brand": {
    "identity": { "productName": "Example Docs Assistant", "companyName": "Example Inc." },
    "assets": { "logoMark": "https://docs.example.com/static/logo-mark.svg" },
    "theme": {
      "colors": { "light": { "brand": "#0F6E56", "brandContrast": "#FFFFFF" } },
      "modeDefault": "system"
    },
    "surfaces": { "widget": { "showBranding": true } }
  }
}

{ "code": "authentication_error", "message": "Authentication is required." }

{ "code": "authorization_error", "message": "This widget may not be embedded from that origin." }

{ "code": "rate_limit_exceeded", "message": "Too many requests. Please retry later." }

Last modified on September 27, 2026

⌘I

// Runs on your website. The widget key is public and belongs in page source.
const MITHUNAI_API = `${MITHUNAI_URL}/arukz/api/v1`
const WIDGET_KEY = 'arukz_wk_8d0f5a2e-3c41-4b7a-9e6d-1f2a3b4c5d6e'

const response = await fetch(`${MITHUNAI_API}/widget/bootstrap`, {
  headers: { 'X-ARUKZ-Widget-Key': WIDGET_KEY },
})
const { status, brand } = await response.json()
console.log(status, brand.identity?.productName)

curl --request GET "$MITHUNAI_URL/arukz/api/v1/widget/bootstrap" \
  --header "X-ARUKZ-Widget-Key: arukz_wk_8d0f5a2e-3c41-4b7a-9e6d-1f2a3b4c5d6e" \
  --header "Origin: https://docs.example.com"

{
  "status": "active",
  "brand": {
    "identity": { "productName": "Example Docs Assistant", "companyName": "Example Inc." },
    "assets": { "logoMark": "https://docs.example.com/static/logo-mark.svg" },
    "theme": {
      "colors": { "light": { "brand": "#0F6E56", "brandContrast": "#FFFFFF" } },
      "modeDefault": "system"
    },
    "surfaces": { "widget": { "showBranding": true } }
  }
}

{ "code": "authentication_error", "message": "Authentication is required." }

{ "code": "authorization_error", "message": "This widget may not be embedded from that origin." }

{ "code": "rate_limit_exceeded", "message": "Too many requests. Please retry later." }

Get started

Conversations

Assistants

Models

Knowledge

Widget deployments

Widget (public)

MCP

API keys

Analytics

Support access

Branding

Operations

Bootstrap the widget on a visitor's page

Response

​Response

Response