App

REST-API

API-Playground

Im Playground probierst du die API direkt im Portal aus, siehst die Antwort und kopierst den passenden curl-Befehl.

Wofür

Der Playground ist eine kleine Werkbank für die API: Du wählst einen Endpunkt, setzt Parameter, schickst die Anfrage ab und siehst Status, Dauer, Kopfzeilen und Antwort. Daneben steht eine kurze Referenz.

Wo du ihn findest

  • Menüpfad: Einstellungen → API Keys → Playground & Doku.
  • Recht: API-Schlüssel verwalten.
  • Tarif: mit API-Zugang, sonst antworten die Endpunkte mit 403.

So schickst du eine Anfrage

  1. Wähle oben im Feld Endpoint den Endpunkt.
  2. Füge deinen Schlüssel ins Feld API Key ein. Die Auswahl „Key wählen…“ zeigt nur die Vorschau deiner Schlüssel, denn Schlüssel werden nur beim Erstellen angezeigt.
  3. Prüfe die Base URL. Vorausgefüllt ist die Adresse, unter der du gerade arbeitest.
  4. Setze im Reiter Parameter z. B. limit oder botId. Unter Headers siehst du die Kopfzeilen, unter Body den JSON-Körper bei POST.
  5. Klicke auf Senden.
  6. Unter Response stehen Status, Dauer und Kopfzeilen. Den passenden curl-Befehl übernimmst du mit Kopieren.

Welche Endpunkte der Playground kennt

EndpunktHinweis
GET /conversations–
GET /conversations/{id}/messagesKennung aus der Gesprächsliste einsetzen
GET /leads–
POST /leadsLegt einen echten Lead an

/verify, /bots und /analytics sind im Playground nicht enthalten. Probiere sie mit curl aus (Beispiele auf den Seiten Authentifizierung, Assistenten und Auswertung).

POST /leads ist echtEin Lead aus dem Playground landet im Lead-Posteingang, löst E-Mails, Slack- oder Teams-Meldungen und Abläufe aus. Nimm einen Test-Assistenten oder sag deinem Team Bescheid.

Die Referenz daneben

Die Seite enthält außerdem eine kurze Referenz zu Authentifizierung, den Grenzen (100 Anfragen pro Stunde mit den Kopfzeilen X-RateLimit-…) und den Fehlercodes. Ausführlich steht alles hier in den Entwickler-Docs.

Fehlerbehebung

ProblemLösung
401Schlüssel vollständig eingefügt? Die Vorschau aus „Key wählen…“ allein reicht nicht.
403Tarif ohne API-Zugang, siehe Abrechnung.
429Die 100 Anfragen pro Stunde gelten auch im Playground.
Knopf „Playground & Doku“ fehltDir fehlt das Recht API-Schlüssel verwalten.

Zurück zur Schlüsselliste kommst du mit Zurück zu API Keys.

VorherigeWebhooksNächsteMCP für Code-Agenten