Webkomponenten-API

Authentifizierung (Erforderlich)

Name	Typ	Erforderlich?	Modus	Beispiel	Beschreibung
orgId	string	Ja	Alle	"org_123"	Deine Blockbrain Organisations-ID.
uid	string	Ja	Alle	"bot_abc"	Einzigartige Bot-/App-Instanz-ID.
clientId	string	Ja	Öffentlich	"pub_456"	Öffentliche Kunden-ID von Blockbrain.
secretKey	string	Ja	Öffentlich	"sk_live_xxx"	Öffentlicher Modus-Geheim; vertraulich behandeln.
issuer	string	Ja	Privat	"https://…blockbrain.ai"	OAuth-Aussteller-URL für deinen Mandanten.

User Identifikation

Name	Typ	Erforderlich?	Standard	Beschreibung
userUid	string	Nein	Neue anonyme Sitzung bei jedem Besuch	Stabile Benutzer-ID (E-Mail, Benutzername, Telefon, etc.), die zur Speicherung des Verlaufs verwendet wird.

Erscheinungsbild & Layout

Name	Typ	Erforderlich?	Standard	Beschreibung
layout	"compact" | "minimal" | "full"	Nein	"full"	Wählt aus, wie viel UI-Chrome/Platz der Chat verwendet (siehe Anleitung unten
width	string (CSS)	Nein	"100%"	Komponentenbreite. Gib einen expliziten Wert an (z. B. „420px“), um ein horizontales Dehnen zu verhindern.
height	string (CSS)	Nein	"100dvh"	Komponentenhöhe. Verwende einen festen Wert (z. B. „600px“), um den Chat innerhalb eines festen Containers scrollbar zu halten.
themeColor	string (CSS color)	Nein	—	Primärfarbe für Buttons und Akzente.

Layout auswählen

• full – Am besten geeignet für Chat-Erlebnisse auf Vollbildseite oder wenn der Chat im Fokus steht. Es erweitert sich, um den verfügbaren Platz vollständig auszufüllen und zeigt alle Steuerungselemente an.

• minimal – Adaptives, leichte chrome. Gut geeignet für die Einbettung in Dashboards, Seitenleisten oder Bereiche, in denen der Chat wichtig, aber nicht dominant ist.

• compact – Sehr kompaktes, mobil-optimiertes Layout. Ideal für kleine Widgets, Popover oder beengte Benutzeroberflächen.

Tipp: Für präzise Steuerung solltest du dein gewähltes Layout immer mit expliziten Breiten- und Höhenangaben kombinieren. Lass das Layout das Chrome-Design bestimmen; definiere die Größe über CSS. Wenn du keine Größen angibst, nimmt „full“ automatisch so viel Platz ein, wie möglich.

Icons & Avatare

Name	Typ	Erforderlich?	Standard	Beschreibung
iconUrl	string	Nein	—	Ausweich-Icon für Nachrichten.
iconSize	string	Nein	—	Größe des Ausweich-Icons (z. B. „50px“).
userAvatar	string	Nein	—	URL des Benutzer-Avatars.
botAvatar	string	Nein	—	URL des Bot-Avatars.

Nachrichtenüberschreibungen

Name	Typ	Erforderlich?	Beschreibung
messages	string (JSON)	Nein	Passe Titel, Beschreibung, iconUrl und iconSize je nach Status (Laden, Fehler usw.) an.

Beispiel{ "messages": { "loading": { "title": "Just a sec…", "description": "Fetching answers", "iconUrl": "/spinner.svg", "iconSize": "32px" } } }

Feature Toggles

Name	Typ	Erforderlich?	Standard	Beschreibung
defaultWebSearchEnabled	boolean or "true"/"false"	Nein	true	Websuche standardmäßig aktivieren.
hideReference	boolean or "true"/"false"	Nein	false	Referenzlinks ausblenden.
openDocumentMode	"auto" | "same_tab" | "new_tab"	Nein	"auto"	Wie man Dokumente öffnet
disableRecording	boolean	Nein	false	Audioaufnahme deaktivieren.
hideTopbar	boolean	Nein	false	Die obere Leiste der Chat-Oberfläche ausblenden.

Proxy / Erweitert

Name	Typ	Erforderlich?	Beschreibung
proxyUrl	string	Nein	Proxy-Basis-URL für API-Anfragen.
customHeaders	object (JSON)	Nein	Statische Header, die mit jeder Anfrage gesendet werden.
getCustomHeaders	function	Nein	Callback zum Setzen von Headern pro Sitzung/Anfrage.