Widget Config - BeforeQuery

The widget calls this endpoint on load to discover server-side configuration. Useful if you’re building a custom UI and need the same runtime flags.

GET https://api.agents.beforequery.com/api/v1/public/knowledge-bases/:knowledgeBaseId/widget-config

Auth: client key.

curl https://api.agents.beforequery.com/api/v1/public/knowledge-bases/kb_xxx/widget-config \
  -H "X-Client-Key: bq_pk_..."

Response

{
  "knowledge_base_id": "kb_uuid",
  "knowledge_base_name": "Acme Docs",
  "captcha_required": true,
  "recaptcha_site_key": "6Lc...",
  "hide_branding_allowed": false,
  "mcp_available": true,
  "mcp_url": "https://mcp.beforequery.com/acme"
}

mcp_oauth is omitted here like mcp_url would be if unset — both fields drop from the response rather than printing false/"" when they don’t apply.

Field	Type	Description
`knowledge_base_id`	`string`	The knowledge base this key resolves to
`knowledge_base_name`	`string`	Display name — the widget uses it in the header and placeholder when no `data-product-name` is set
`captcha_required`	`bool`	Whether this client key enforces reCAPTCHA v3; when `true`, chat requests must include a token (see Authentication)
`recaptcha_site_key`	`string`	Site key to render the reCAPTCHA v3 challenge client-side
`hide_branding_allowed`	`bool`	`true` only for enterprise-plan workspaces — gates the widget’s `data-hide-branding` option. On other plans the “Powered by BeforeQuery” footer stays visible even if the attribute is set
`mcp_available`	`bool`	`true` for a public key with MCP access enabled, or for a knowledge base with OAuth sign-in turned on (`mcp_oauth_enabled`) — OAuth needs no key at all. Gates the widget’s “Connect to AI Tools” menu
`mcp_url`	`string`	The knowledge base’s MCP server address. Empty unless it has an address configured and something can authenticate against it; fall back to `{baseUrl}/mcp`, which the client key already scopes
`mcp_oauth`	`bool`	`true` when `mcp_url` authenticates readers itself via OAuth sign-in. The install instructions for it should carry no credential at all

Typical custom-UI flow

Fetch widget-config on load.
If captcha_required, load reCAPTCHA v3 with recaptcha_site_key and obtain a token before each chat call (X-Captcha-Token header, or captcha_token on WebSocket frames).
Respect hide_branding_allowed when deciding whether to show attribution.
If mcp_available, offer readers the MCP install — using mcp_url when it’s set.