Was ist die Hedy API?
Die Hedy API bietet programmgesteuerten Zugriff auf Ihre Meeting-Daten, Transkripte, Zusammenfassungen und KI-generierte Erkenntnisse. Ob Sie benutzerdefinierte Integrationen erstellen, Workflows automatisieren oder sich mit Tools wie Zapier verbinden – die API gibt Ihnen die Möglichkeit, Hedys Funktionen über die App hinaus zu erweitern. Alle API-Funktionen erfordern ein Pro-Abonnement mit aktivierter Cloud-Synchronisierung.
Erste Schritte mit der API
Öffnen Sie die Hedy-App und navigieren Sie zu Kontoeinstellungen
Scrollen Sie zum Abschnitt API-Zugriff
Klicken Sie auf Neuen API-Schlüssel generieren (Pro-Abonnement erforderlich)
Kopieren Sie Ihren API-Schlüssel und speichern Sie ihn sicher – Sie können ihn später nicht erneut sehen
Besuchen Sie unsere API-Dokumentation auf SwaggerHub für detaillierte Endpunktinformationen oder greifen Sie auf die rohe OpenAPI-Spezifikation unter https://api.hedy.bot/v1/docs zu
Sicherheitshinweis: Ihr API-Schlüssel bietet vollständigen Zugriff auf Ihre Hedy-Daten. Bewahren Sie ihn sicher auf und teilen Sie ihn niemals öffentlich oder committen Sie ihn in die Versionskontrolle.
API-Funktionen
Die Hedy API bietet umfassenden Zugriff auf Ihre Meeting-Intelligenz:
Sitzungen: Listen und Abrufen Ihrer Meetingsitzungen, einschließlich vollständiger Transkripte, KI-Zusammenfassungen und Kernpunkte
Highlights: Abrufen wichtiger Momente aus Ihren Meetings mit KI-generierten Erkenntnissen
Themen: Erstellen, aktualisieren, löschen und Organisieren von Sitzungen nach Themen mit benutzerdefinierten Kontextanweisungen
Aufgaben: Abrufen und Verwalten von Aktionspunkten über alle Sitzungen hinweg
Sitzungskontexte: Erstellen und Verwalten wiederverwendbarer Anweisungen, die steuern, wie Hedy Ihre Meetings analysiert
Webhooks: Konfigurieren und Verwalten von Webhook-Endpunkten über die API für Echtzeit-Ereignisbenachrichtigungen
Benutzerinfo: Abrufen Ihrer Kontodetails über den Endpunkt /me
Authentifizierung
Alle API-Anfragen erfordern eine Authentifizierung mit Ihrem API-Schlüssel. Fügen Sie ihn in den Authorization-Header ein:
Authorization: Bearer YOUR_API_KEY
Webhooks
Richten Sie Webhooks ein, um Echtzeitbenachrichtigungen zu erhalten, wenn Ereignisse in Ihrem Hedy-Konto auftreten:
Klicken Sie im Abschnitt API-Zugriff auf Webhooks verwalten
Klicken Sie auf die Schaltfläche +, um einen neuen Webhook hinzuzufügen
Geben Sie Ihre HTTPS-Endpunkt-URL ein
Wählen Sie die Ereignisse aus, die Sie empfangen möchten:
session.created - Wenn eine neue Aufnahmesitzung startet
session.ended - Wenn eine Aufnahmesitzung die Verarbeitung abgeschlossen hat
session.exported - Wenn eine Sitzung manuell vom Benutzer 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 Signiergeheimnis für die Payload-Verifizierung
Sie können Webhooks auch programmgesteuert über die API mit GET, POST und DELETE am Endpunkt /webhooks verwalten. Jedes Konto kann bis zu 50 Webhooks haben.
Webhook-Signaturverifizierung
Jede Webhook-Zustellung enthält eine Signatur im Header X-Hedy-Signature, damit Sie überprüfen können, dass sie von Hedy stammt. Die Signatur ist ein HMAC-SHA256-Hash des rohen Request-Bodys, signiert mit dem Signiergeheimnis Ihres Webhooks. Verifizieren Sie die Signatur auf Ihrem Server, bevor Sie die Payload verarbeiten, um die Authentizität sicherzustellen. Jede Zustellung enthält außerdem einen Header X-Hedy-Event, der den Ereignistyp angibt (z. B. session.ended).
Sitzungskontexte
Sitzungskontexte ermöglichen es Ihnen, wiederverwendbare Sätze benutzerdefinierter Anweisungen zu erstellen, die Hedy mitteilen, wie Ihre Meetings analysiert werden sollen. Beispielsweise könnten Sie einen Kontext für „Vertriebsgespräche“ erstellen, der sich auf Aktionspunkte und Kundeneinwände konzentriert, oder einen für „Standup-Meetings“, der Blocker und Updates verfolgt.
Verwalten Sie Ihre Sitzungskontexte über die API:
GET /contexts - Alle Sitzungskontexte auflisten
GET /contexts/{id} - Einen bestimmten Kontext anhand der ID abrufen
POST /contexts - Einen neuen Kontext erstellen (Titel und Inhalt)
PATCH /contexts/{id} - Einen bestehenden Kontext aktualisieren
DELETE /contexts/{id} - Einen Kontext entfernen
Legen Sie einen Kontext als Standard fest, dann wird er automatisch auf alle neuen Sitzungen angewendet. Konten der kostenlosen Stufe sind auf 1 Sitzungskontext beschränkt.
Themen über die API verwalten
Themen helfen Ihnen, Ihre Sitzungen in Kategorien zu organisieren. Die API unterstützt die vollständige Themenverwaltung:
GET /topics - Alle Themen mit KI-generierten Erkenntnissen und Sitzungsanzahl auflisten
GET /topics/{id} - Details zu einem bestimmten Thema abrufen
POST /topics - Ein neues Thema mit Name, Beschreibung, Farbe und Symbol erstellen
PATCH /topics/{id} - Eigenschaften oder benutzerdefinierten Kontext eines Themas aktualisieren
DELETE /topics/{id} - Ein Thema entfernen (Sitzungen werden getrennt, nicht gelöscht)
GET /topics/{id}/sessions - Alle Sitzungen innerhalb eines Themas auflisten
Themen können ein Feld topicContext mit benutzerdefinierten Anweisungen (bis zu 20.000 Zeichen) enthalten, die steuern, wie Hedy Sitzungen analysiert, die diesem Thema zugewiesen sind.
Häufige Anwendungsfälle
Projektmanagement-Integration: Aufgaben in Ihrem PM-Tool automatisch aus Meeting-Aktionspunkten erstellen
Wissensmanagement: Meeting-Inhalte in der Wissensbasis Ihres Unternehmens indexieren
CRM-Integration: Kundendatensätze mit Meeting-Erkenntnissen aktualisieren
Analyse-Dashboards: Benutzerdefinierte Berichte zu Meeting-Mustern 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 zu Endpunkten hinzu, um Zapier-kompatible flache Array-Antworten zu erhalten)
API-Limits und Best Practices
Rate-Limits: 200 Anfragen pro Minute und API-Schlüssel
Paginierung: Verwenden Sie den Parameter limit (Standard 50, Maximum 100) und den Cursor-Parameter after, um Ergebnisse seitenweise abzurufen
Antworten nach Möglichkeit cachen, um API-Aufrufe zu reduzieren
Fehler sauber mit exponentiellem Backoff behandeln
Webhooks für Echtzeit-Updates statt Polling verwenden
Aufgaben automatisch exportieren
Aktivieren Sie den automatischen Aufgabenexport, um Aktionspunkte an Ihre integrierten Systeme zu senden:
Schalten Sie im Abschnitt API-Zugriff Aufgaben automatisch exportieren ein
Aufgaben werden automatisch an Ihre konfigurierten Webhook-Endpunkte gesendet
Jede Aufgabe enthält Kontext, Vorschläge für Zuständige und die Meeting-Referenz
Codebeispiele
Hier ist ein einfaches Beispiel, um Ihre letzten Sitzungen abzurufen:
curl -X GET "https://api.hedy.bot/v1/sessions?limit=10" \ -H "Authorization: Bearer YOUR_API_KEY"
Für weitere Beispiele und die vollständige Endpunktreferenz besuchen Sie unsere API-Dokumentation.
Fehlerbehebung
401 Unauthorized Error
Vergewissern Sie sich, dass Ihr API-Schlüssel korrekt und richtig formatiert ist
Stellen Sie sicher, dass Sie ein aktives Pro-Abonnement haben
Prüfen Sie, dass die Cloud-Synchronisierung in Ihrem Konto aktiviert ist
Bestätigen Sie, dass der API-Schlüssel nicht neu generiert wurde (alte Schlüssel werden ungültig)
Leere Antwort oder fehlende Daten
Stellen Sie sicher, dass die Cloud-Synchronisierung aktiviert ist – die API greift nur auf cloud-synchronisierte Daten zu
Warten Sie ein paar Minuten nach der Aufnahme, damit die Daten synchronisieren können
Überprüfen Sie Ihre Datumsfilter und Paginierungsparameter
Stellen Sie sicher, dass Sie den richtigen Endpunkt für Ihren Datentyp verwenden
Webhook empfängt keine Ereignisse
Bestätigen Sie, dass Ihre Endpunkt-URL HTTPS verwendet (erforderlich)
Prüfen Sie, dass Ihr Server mit Status 200 OK antwortet
Verifizieren Sie den Header X-Hedy-Signature, falls Sie die Signaturprüfung implementieren
Testen Sie Ihren Webhook mit der Schaltfläche „Webhook testen“
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
Batch-Operationen nutzen, wo möglich
Kontaktieren Sie den Support, wenn Sie höhere Limits benötigen
Profi-Tipp: Verwenden Sie Webhooks statt Polling für Echtzeit-Updates. Das ist effizienter und liefert sofortige Benachrichtigungen, wenn sich Ihre Daten ändern.
Datenschutz und Sicherheit
Die Sicherheit Ihrer Daten hat höchste Priorität:
Die gesamte API-Kommunikation verwendet HTTPS-Verschlüsselung
API-Schlüssel können jederzeit neu generiert werden (ungültig macht den alten Schlüssel)
Webhook-Payloads sind zur Verifizierung mit HMAC-SHA256 signiert
Daten sind nur mit gültiger Authentifizierung zugänglich
Alle Endpunkte erzwingen strenge Sicherheits-Header
Hilfe erhalten
Bei API-spezifischen Fragen:
Durchsuchen Sie die API-Dokumentation für Endpunktdetails und Schemas
Lesen Sie unseren API-Ankündigungs-Blogbeitrag für Beispiele und Anwendungsfälle
Treten Sie unserer Slack-Community bei, um Unterstützung zu erhalten und Ihre Integrationen zu teilen