Hedy API

API-Zugriffseinstellungen mit Endpoint-URLs und API-Key-Generierung

Was ist die Hedy API?

Die Hedy API bietet programmatischen Zugriff auf Ihre Meeting-Daten, Transkripte, Zusammenfassungen und KI-generierte Erkenntnisse. Ob Sie benutzerdefinierte Integrationen erstellen, Workflows automatisieren oder Tools wie Zapier anbinden - die API gibt Ihnen die Möglichkeit, Hedys Funktionen über die App hinaus zu erweitern. Alle API-Funktionen erfordern ein Pro-Abonnement mit aktiviertem Cloud Sync. Wenn Sie möchten, dass ein KI-Assistent dialogisch mit diesen Daten arbeitet, statt Code zu schreiben, können Sie Hedy auch mit KI-Assistenten über MCP verbinden.

Erste Schritte mit der API

Öffnen Sie die Hedy-App und navigieren Sie zu Account Settings
Scrollen Sie zum Bereich API-Zugriff
Klicken Sie auf Generate New API Key (Pro-Abonnement erforderlich)
Kopieren Sie Ihren API Key und bewahren Sie ihn sicher auf - Sie können ihn nicht erneut einsehen
Besuchen Sie unsere API-Dokumentation auf SwaggerHub für detaillierte Endpoint-Informationen, oder greifen Sie auf die OpenAPI-Spezifikation unter https://api.hedy.bot/docs zu

Sicherheitshinweis: Ihr API Key bietet vollen Zugriff auf Ihre Hedy-Daten. Bewahren Sie ihn sicher auf und teilen Sie ihn niemals öffentlich oder committen Sie ihn in Versionskontrollsysteme.

Endpoint-URLs nach Region

Die Hedy API läuft in zwei Regionen, damit Nutzerdaten in der richtigen Rechtsordnung bleiben. Verwenden Sie die Basis-URL, die zu der Region passt, in der Ihr Konto erstellt wurde:

US-Konten: https://api.hedy.bot
EU-Konten: https://eu-api.hedy.bot

Beide Regionen führen denselben Code aus und stellen dieselben Endpoints bereit - es gibt keinen Funktionsunterschied. Ihr API Key ist an die Region Ihres Kontos gebunden, daher schlagen Aufrufe an die falsche Basis-URL bei der Authentifizierung fehl. Wenn Sie unsicher sind, welche Region Ihr Konto nutzt, öffnen Sie Hedy und gehen Sie zu Einstellungen -> Datenschutz & System -> Datenschutzpräferenzen; das Flaggensymbol zeigt, wo Ihre Daten gespeichert sind.

Die Beispiele in diesem Artikel verwenden https://api.hedy.bot. Wenn Ihr Konto in der EU liegt, ersetzen Sie diese URL überall durch https://eu-api.hedy.bot.

API-Funktionen

Die Hedy API bietet umfassenden Zugriff auf Ihre Meeting-Intelligenz:

Sitzungen: Listen und Abrufen Ihrer Meeting-Sitzungen, einschließlich vollständiger Transkripte, KI-Zusammenfassungen und Kernpunkte
Highlights: Abrufen wichtiger Momente aus Ihren Meetings mit KI-generierten Erkenntnissen
Topics: Erstellen, Aktualisieren, Löschen und Organisieren von Sitzungen nach Themen mit benutzerdefinierten Kontextanweisungen
Todos: Abrufen und Verwalten von Aufgaben über alle Sitzungen hinweg
Session Contexts: Erstellen und Verwalten wiederverwendbarer Anweisungen, die steuern, wie Hedy Ihre Meetings analysiert
Benutzerdefiniertes Vokabular: Abrufen und Ersetzen der Vokabelliste des Kontos, die die Transkription von Namen und Fachbegriffen verbessert
Webhooks: Konfigurieren und Verwalten von Webhook-Endpoints über die API für Echtzeit-Ereignisbenachrichtigungen
User Info: Abrufen Ihrer Kontodetails über den /me-Endpoint

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit Ihrem API Key. Fügen Sie ihn im Authorization-Header ein:

Authorization: Bearer YOUR_API_KEY

Webhooks

Richten Sie Webhooks ein, um Echtzeit-Benachrichtigungen zu erhalten, wenn Ereignisse in Ihrem Hedy-Konto auftreten:

Klicken Sie im Bereich API Access auf Manage Webhooks
Klicken Sie auf die +-Schaltfläche, um einen neuen Webhook hinzuzufügen
Geben Sie Ihre HTTPS-Endpoint-URL ein
Wählen Sie die Ereignisse, die Sie empfangen möchten:
- session.created - Wenn eine neue Sitzung startet
- session.ended - Wenn eine Sitzung die Verarbeitung abschließt
- session.exported - Wenn eine Sitzung manuell vom Nutzer exportiert wird
- highlight.created - Wenn ein neues Highlight hinzugefügt wird
- todo.exported - Wenn Aufgaben aus einer Sitzung exportiert werden
Speichern Sie Ihren Webhook und notieren Sie das Signing Secret für die Payload-Verifizierung

Sie können Webhooks auch programmatisch über die API mit GET, POST und DELETE auf dem /webhooks-Endpoint verwalten. Jedes Konto kann bis zu 50 Webhooks haben.

Webhook-Signaturverifizierung

Jede Webhook-Zustellung enthält eine Signatur im X-Hedy-Signature-Header, damit Sie verifizieren können, dass sie von Hedy stammt. Die Signatur ist ein HMAC-SHA256-Hash des rohen Request-Bodys, signiert mit dem Signing Secret Ihres Webhooks. Verifizieren Sie die Signatur auf Ihrem Server, bevor Sie die Payload verarbeiten, um die Authentizität sicherzustellen. Jede Zustellung enthält auch einen X-Hedy-Event-Header, der den Ereignistyp angibt (z.B. session.ended).

Session Contexts

Session Contexts ermöglichen es Ihnen, wiederverwendbare Anweisungen zu erstellen, die Hedy mitteilen, wie Ihre Meetings analysiert werden sollen. Sie könnten beispielsweise einen Kontext für “Vertriebsgespräche” erstellen, der sich auf Aufgaben und Kundeneinwände konzentriert, oder einen für “Standup-Meetings”, der Blocker und Updates verfolgt.

Verwalten Sie Ihre Session Contexts über die API:

GET /contexts - Alle Ihre Session Contexts auflisten
GET /contexts/{id} - Einen bestimmten Kontext nach ID abrufen
POST /contexts - Einen neuen Kontext erstellen (Titel und Inhalt)
PATCH /contexts/{id} - Einen bestehenden Kontext aktualisieren
DELETE /contexts/{id} - Einen Kontext entfernen

Setzen Sie einen Kontext als Standard und er wird automatisch auf alle neuen Sitzungen angewendet. Konten der kostenlosen Stufe sind auf 1 Session Context beschränkt.

Topics über die API verwalten

Topics helfen Ihnen, Ihre Sitzungen in Kategorien zu organisieren. Die API unterstützt die vollständige Topic-Verwaltung:

GET /topics - Alle Topics mit KI-generierten Erkenntnissen und Sitzungsanzahlen auflisten
GET /topics/{id} - Details eines bestimmten Topics abrufen
POST /topics - Neues Topic mit Name, Beschreibung, Farbe, Symbol und Standard-Sitzungstyp erstellen
PATCH /topics/{id} - Eigenschaften, benutzerdefinierten Kontext oder Standard-Sitzungstyp eines Topics aktualisieren
DELETE /topics/{id} - Ein Topic entfernen (Sitzungen werden entkoppelt, nicht gelöscht)
GET /topics/{id}/sessions - Alle Sitzungen innerhalb eines Topics auflisten

Topics können ein topicContext-Feld mit benutzerdefinierten Anweisungen (bis zu 20.000 Zeichen) enthalten, die steuern, wie Hedy dem Topic zugeordnete Sitzungen analysiert. Diese Anweisungen werden automatisch auf jede unter dem Topic gestartete Sitzung angewendet, einschließlich der Live-Vorschläge während der Sitzung. Wenn Sie ein Topic über die API vorbereiten, ist damit also auch die Sitzung vorbereitet.

Topics akzeptieren außerdem ein dominantSessionType-Feld. Es legt fest, welchen Sitzungstyp eine unter diesem Topic gestartete Sitzung verwendet. Das ist nützlich, wenn Sie Topics programmatisch erstellen und nicht möchten, dass alle auf den Standardtyp zurückfallen. Das Feld dient zugleich als abgeleitete Statistik: Sobald ein Topic Sitzungen enthält, berechnet Hedy es anhand der tatsächlich verwendeten Typen neu. Ein von Ihnen gesetzter Wert ist daher ein Ausgangspunkt und keine dauerhafte Einstellung. Wenn Sie den Wert bei einem Topic setzen, das bereits Sitzungen enthält, gilt er als einmalige Überschreibung für die nächste Sitzung. Die API-Referenz führt die zulässigen Werte für Sitzungstypen auf.

Benutzerdefiniertes Vokabular

Mit benutzerdefiniertem Vokabular lernt Hedy die Namen, Abkürzungen und Fachbegriffe kennen, die für Ihre Arbeit relevant sind. Dadurch werden diese genauer transkribiert. Die Liste ist in Ihrem Konto gespeichert und gilt für jede Sitzung.

GET /vocabulary - Aktuelle Begriffsliste und Aktivierungsstatus des Vokabulars abrufen
PUT /vocabulary - Gesamte Begriffsliste ersetzen

PUT ersetzt die gesamte Liste, statt Begriffe hinzuzufügen. Jeder gespeicherte Begriff, den Sie auslassen, wird daher entfernt. Senden Sie bis zu 100 Begriffe mit jeweils 2 bis 50 Zeichen. Begriffe müssen eindeutig sein (beim Vergleich wird die Groß-/Kleinschreibung ignoriert) und dürfen keine spitzen, geschweiften oder eckigen Klammern, Backslashes, senkrechten Striche, Backticks oder Tilden enthalten.

Das Flag enabled kann sowohl gelesen als auch geschrieben werden. Lassen Sie es beim Ersetzen der Begriffe weg, bleibt der gespeicherte Wert unverändert. Das ist wichtig, wenn Sie Vokabularaktualisierungen automatisieren: Wenn Sie das Flag zuerst auslesen, wissen Sie, ob die geschriebenen Begriffe tatsächlich verwendet werden oder nur in einem Konto gespeichert sind, in dem das Vokabular deaktiviert ist.

Da ein einziger Aufruf die gesamte Liste austauscht, können Sie das Vokabular vor jedem Meeting passend zu den dort benötigten Namen und Fachbegriffen ersetzen, statt eine einzige lange Gesamtliste zu pflegen.

Häufige Anwendungsfälle

Projektmanagement-Integration: Automatisch Aufgaben in Ihrem PM-Tool aus Meeting-Aktionspunkten erstellen
Wissensmanagement: Meeting-Inhalte in der Wissensdatenbank Ihres Unternehmens indizieren
CRM-Integration: Kundeneinträge mit Meeting-Erkenntnissen aktualisieren
Analyse-Dashboards: Benutzerdefinierte Berichte über Meeting-Muster und Produktivität erstellen
Workflow-Automatisierung: Aktionen basierend auf Meeting-Inhalten oder -Abschluss auslösen
Zapier-Integration: Hedy mit Tausenden von Apps über Zapier verbinden (fügen Sie ?format=zapier an Endpoints für Zapier-kompatible flache Array-Antworten an)

API-Limits und Best Practices

Rate-Limits: 200 Anfragen pro Minute pro API Key
Paginierung: Verwenden Sie den limit-Parameter (Standard 50, Maximum 100) und den after-Cursor-Parameter, um durch Ergebnisse zu blättern
Cachen Sie Antworten nach Möglichkeit, um API-Aufrufe zu reduzieren
Behandeln Sie Fehler elegant mit exponentiellem Backoff
Verwenden Sie Webhooks für Echtzeit-Updates anstelle von Polling

Automatischer Aufgabenexport

Aktivieren Sie den automatischen Aufgabenexport, um Aufgaben an Ihre integrierten Systeme zu senden:

Aktivieren Sie im Bereich API Access Auto Export Todos
Aufgaben werden automatisch an Ihre konfigurierten Webhook-Endpoints gesendet
Jede Aufgabe enthält Kontext, Zuweisungsvorschläge und Meeting-Referenz

Code-Beispiele

Hier ein einfaches Beispiel, um Ihre letzten Sitzungen abzurufen:

curl -X GET "https://api.hedy.bot/sessions?limit=10" \  -H "Authorization: Bearer YOUR_API_KEY"

Weitere Beispiele und die vollständige Endpoint-Referenz finden Sie in unserer API-Dokumentation.

Fehlerbehebung

401 Unauthorized Error

Prüfen Sie, ob Ihr API Key korrekt und richtig formatiert ist
Stellen Sie sicher, dass Sie ein aktives Pro-Abonnement haben
Prüfen Sie, ob Cloud Sync in Ihrem Konto aktiviert ist
Bestätigen Sie, dass der API Key nicht neu generiert wurde (alte Keys werden ungültig)

Leere Antwort oder fehlende Daten

Stellen Sie sicher, dass Cloud Sync aktiviert ist - die API greift nur auf cloud-synchronisierte Daten zu
Warten Sie nach einer Sitzung einige Minuten, bis die Daten synchronisiert sind
Prüfen Sie Ihre Datumsfilter und Paginierungsparameter
Stellen Sie sicher, dass Sie den richtigen Endpoint für Ihren Datentyp verwenden

Webhook empfängt keine Ereignisse

Bestätigen Sie, dass Ihre Endpoint-URL HTTPS verwendet (erforderlich)
Prüfen Sie, ob Ihr Server mit dem Statuscode 200 OK antwortet
Überprüfen Sie den X-Hedy-Signature-Header, wenn Sie Signaturverifizierung implementieren
Testen Sie Ihren Webhook mit der Schaltfläche “Test Webhook”
Prüfen Sie, ob Firewall-Regeln Hedys Server blockieren

Rate-Limit überschritten

Implementieren Sie Caching, um redundante API-Aufrufe zu reduzieren
Verwenden Sie Webhooks für Echtzeit-Updates statt Polling
Bündeln Sie Operationen nach Möglichkeit
Kontaktieren Sie den Support, wenn Sie höhere Limits benötigen

Profi-Tipp: Verwenden Sie Webhooks statt Polling für Echtzeit-Updates. Dies ist effizienter und bietet sofortige Benachrichtigungen, wenn sich Ihre Daten ändern.

Datenschutz und Sicherheit

Die Sicherheit Ihrer Daten hat für uns Priorität:

Alle API-Kommunikation verwendet HTTPS-Verschlüsselung
API Keys können jederzeit neu generiert werden (alte Keys werden ungültig)
Webhook-Payloads werden mit HMAC-SHA256 zur Verifizierung signiert
Daten sind nur mit gültiger Authentifizierung zugänglich
Alle Endpoints erzwingen strenge Security-Header

Hilfe erhalten

Für API-spezifische Fragen:

Durchsuchen Sie die API-Dokumentation für Endpoint-Details und Schemas
Lesen Sie unseren API-Ankündigungs-Blogpost für Beispiele und Anwendungsfälle
Treten Sie unserer Slack-Community bei für Support und zum Teilen Ihrer Integrationen