Webkomponenten-API

Authentifizierung (erforderlich)

Name	Typ	Erforderlich?	Modus	Beispiel	Beschreibung
orgId	string	Ja	Alle	"org_123"	Ihre Blockbrain-Org-ID.
uid	string	Ja	Alle	"bot_abc"	Eindeutige Bot-/App-Instanz-ID
issuer	string	Ja	Privat	"https://…blockbrain.ai"	OAuth-Issuer-URL für Ihren Mandanten.

Benutzeridentifikation

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

Erscheinungsbild & Layout

Name	Typ	Erforderlich?	Standard	Beschreibung
layout	"compact" | "minimal" | "full"	Nein	"full"	Legt fest, wie viel UI-Umgebung/Platz der Chat verwendet (siehe Hinweise unten).
Breite	Zeichenfolge (CSS)	Nein	"100%"	Komponentenbreite. Legen Sie einen expliziten Wert fest (z. B. "420px"), um zu verhindern, dass es sich horizontal streckt.
Höhe	Zeichenfolge (CSS)	Nein	"100dvh"	Komponentenhöhe. Verwenden Sie einen festen Wert (z. B. "600px"), damit der Chat in einem festen Container scrollbar bleibt.
themeColor	Zeichenfolge (CSS-Farbe)	Nein	—	Primäre Designfarbe für Schaltflächen und Akzente.

Auswahl eines layout

• full – Am besten für Chat-Erlebnisse auf der ganzen Seite oder wenn der Chat im Mittelpunkt steht. Er erweitert sich, um den verfügbaren Platz zu füllen, und zeigt alle Steuerelemente.

• minimal – Anpassungsfähige, leichtere Oberfläche. Gut zum Einbetten in Dashboards, Seitenleisten oder Bereiche, in denen der Chat wichtig, aber nicht dominant ist.

• compact – Extrem kompakte, mobilartige Anordnung. Ideal für winzige Widgets, Popovers oder enge UI-Bereiche.

Tipp: Für präzise Kontrolle sollten Sie Ihre gewählte layout immer mit expliziten Breite und Höhe. Lassen Sie das Layout die Oberfläche bestimmen; lassen Sie die CSS-Größen den Platzbedarf festlegen. Wenn Sie Größen weglassen, full nimmt es gerne alles, was es bekommen kann.

Symbole & Avatare

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

introImageUrl — URL des Startlogos, das vor der ersten Chat-Nachricht angezeigt wird

Nachrichtenüberschreibungen

Name	Typ	Erforderlich?	Beschreibung
messages	Zeichenfolge (JSON)	Nein	Anpassen Titel, Beschreibung, iconUrl, iconSize pro Status (laden, Fehler, usw.).

Beispiel

{ "messages": { "loading": { "title": "Einen Moment…", "description": "Antworten werden abgerufen", "iconUrl": "/spinner.svg", "iconSize": "32px" } } }

Feature-Umschalter

Name	Typ	Erforderlich?	Standard	Beschreibung
defaultWebSearchEnabled	boolesch oder "true"/"false"	Nein	true	Websuche standardmäßig aktivieren.
hideReference	boolesch oder "true"/"false"	Nein	false	Referenzlinks ausblenden.
openDocumentMode	"auto" | "same_tab" | "new_tab"	Nein	"auto"	Wie Dokumente geöffnet werden.
disableRecording	boolesch	Nein	false	Audioaufzeichnung deaktivieren.
hideTopbar	boolesch	Nein	false	Die obere Leiste der Chat-UI ausblenden.
defaultSidebarOpen	boolesch oder "true"/"false"	Nein	false	Standardmäßig das Ein-/Ausblenden der Seitenleiste steuern

Proxy / Erweitert

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