REST-API

Assistenten

Die aktiven Assistenten deines Workspaces mit Kennung, Farbe und Widget-Schlüssel abrufen.

Wofür

Mit GET /bots holst du die Kennungen deiner Assistenten. Du brauchst sie als botId für andere Endpunkte und, zusammen mit Workspace und Widget-Schlüssel, um das Widget aus deinem eigenen System heraus einzubinden. Der Pfad heißt aus historischen Gründen /bots.

Anfrage

curlbash

curl https://app.lymbe.ai/api/v1/bots \
  -H "x-api-key: lymbe_DEIN_SCHLUESSEL"

fetchjavascript

const res = await fetch('https://app.lymbe.ai/api/v1/bots', {
  headers: { 'x-api-key': process.env.LYMBE_API_KEY },
});
const { tenantSlug, bots } = await res.json();

Antwort

Antwort 200json

{
  "tenantSlug": "dein-workspace",
  "bots": [
    {
      "id": "BOT_ID",
      "name": "Website-Assistent",
      "isActive": true,
      "avatarUrl": null,
      "primaryColor": "#09CC78",
      "widgetKey": "WIDGET_SCHLUESSEL"
    }
  ]
}

Feld	Bedeutung
`tenantSlug`	Kurzname deines Workspaces, für `data-tenant` im Widget-Code
`id`	Kennung des Assistenten, für `botId` und `data-bot-id`
`name`	Name des Assistenten
`isActive`	Immer `true`: Die Liste enthält nur aktive Assistenten
`avatarUrl`	Eigenes Bild, sonst `null`
`primaryColor`	Akzentfarbe, Standard `#09CC78`
`widgetKey`	Widget-Schlüssel für `data-key`; leer, solange der Assistent noch nie gespeichert wurde

Was du wissen solltest

Inaktive Assistenten fehlen in der Liste.
Die neuesten Assistenten stehen oben.
Der Endpunkt zählt nicht zur Grenze von 100 Anfragen pro Stunde, braucht aber einen Tarif mit API-Zugang (sonst 403).
Der Widget-Schlüssel ist kein Geheimnis wie der API-Schlüssel: Er steht später sichtbar im Quelltext deiner Website. Er sorgt dafür, dass nur das Widget mit dem Assistenten sprechen kann.

Server, z. B. für ein CMS-Pluginjavascript

const { tenantSlug, bots } = await (await fetch(base + '/bots', { headers })).json();
const bot = bots[0];
const snippet =
  '<script src="https://app.lymbe.ai/widget.js"' +
  ' data-bot-id="' + bot.id + '"' +
  ' data-tenant="' + tenantSlug + '"' +
  ' data-key="' + bot.widgetKey + '"></script>';

Fertigen Code ohne API bekommst du im Portal unter Assistent öffnen (Zahnrad) → Einbetten (siehe Einbindung).

Häufige Fragen

Frage	Antwort
Kann ich Assistenten über die API anlegen oder ändern?	Nein. Das geht im Portal unter Assistenten.
`widgetKey` ist leer	Öffne den Assistenten im Portal und speichere ihn einmal. Dabei entsteht der Schlüssel.
Mein interner Assistent fehlt im Widget	Interne Assistenten haben kein Widget. Sie arbeiten nur im Portal.

VorherigeLeads NächsteAuswertung