Was ist die Hedy API?
Die Hedy API bietet programmatischen Zugriff auf Ihre Sitzungsdaten, Transkripte, Zusammenfassungen und KI-generierten Erkenntnisse. Egal, ob Sie benutzerdefinierte Integrationen erstellen, Arbeitsabläufe automatisieren oder Verbindungen zu Tools wie Zapier herstellen, 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.
Einstieg in die 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 bewahren Sie ihn sicher auf – Sie können ihn nicht mehr sehen
Besuchen Sie unsere API-Dokumentation auf SwaggerHub für detaillierte Endpunkt-Informationen oder greifen Sie auf die OpenAPI-Spezifikation unter https://api.hedy.bot/v1/docs zu.
Sicherheitshinweis: Ihr API-Schlüssel bietet vollen Zugriff auf Ihre Hedy-Daten. Bewahren Sie ihn sicher auf, teilen Sie ihn niemals öffentlich und übertragen Sie ihn nicht in die Versionskontrolle.
API-Funktionen
Die Hedy API bietet umfassenden Zugriff auf Ihre Meeting-Intelligenz:
Sitzungen: Listen Sie Ihre Sitzungen auf und rufen Sie diese ab, einschließlich vollständiger Transkripte, KI-Zusammenfassungen und Kernpunkte
Highlights: Rufen Sie wichtige Momente aus Ihren Meetings mit KI-generierten Erkenntnissen ab
Themen: Erstellen, aktualisieren, löschen und organisieren Sie Sitzungen nach Themen mit benutzerdefinierten Kontextanweisungen
Aufgaben: Rufen Sie Aktionspunkte über alle Sitzungen hinweg ab und verwalten Sie diese
Sitzungskontexte: Erstellen und verwalten Sie wiederverwendbare Anweisungen, die steuern, wie Hedy Ihre Meetings analysiert
Webhooks: Konfigurieren und verwalten Sie Webhook-Endpunkte über die API für Echtzeit-Ereignisbenachrichtigungen
Kontoinformationen: Rufen Sie Ihre Kontodetails über den Endpunkt /me ab
Authentifizierung
Alle API-Anfragen erfordern eine Authentifizierung mit Ihrem API-Schlüssel. Geben Sie diesen im Authorization-Header an:
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 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 Aufzeichnungssitzung startet
session.ended – Wenn eine Aufzeichnungssitzung 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 sich das Signatur-Geheimnis für die Verifizierung der Nutzlast
Sie können Webhooks auch programmatisch über die API mit GET, POST und DELETE am Endpunkt /webhooks verwalten. Jedes Konto kann bis zu 50 Webhooks haben.
Verifizierung der Webhook-Signatur
Jede Webhook-Zustellung enthält eine Signatur im Header X-Hedy-Signature, damit Sie verifizieren können, dass sie von Hedy stammt. Die Signatur ist ein HMAC-SHA256-Hash des rohen Anfrage-Bodys, signiert mit dem Signatur-Geheimnis Ihres Webhooks. Verifizieren Sie die Signatur auf Ihrem Server, bevor Sie die Nutzlast verarbeiten, um die Authentizität sicherzustellen. Jede Zustellung enthält auch einen Header X-Hedy-Event, der den Ereignistyp angibt (z. B. session.ended).
Sitzungskontexte
Sitzungskontexte ermöglichen es Ihnen, wiederverwendbare Sätze von benutzerdefinierten Anweisungen zu erstellen, die Hedy sagen, wie Ihre Meetings analysiert werden sollen. Sie könnten beispielsweise einen Kontext für „Verkaufsgespräche“ erstellen, der sich auf Aktionspunkte und Kundeneinwände konzentriert, oder einen für „Standup-Meetings“, der Hindernisse und Updates verfolgt.
Nutzen Sie die API, um Ihre Sitzungskontexte zu verwalten:
GET /contexts – Liste all Ihrer Sitzungskontexte
GET /contexts/{id} – Abrufen eines spezifischen Kontexts per ID
POST /contexts – Erstellen eines neuen Kontexts (Titel und Inhalt)
PATCH /contexts/{id} – Aktualisieren eines bestehenden Kontexts
DELETE /contexts/{id} – Entfernen eines Kontexts
Legen Sie einen Kontext als Standard fest, und er wird automatisch auf alle neuen Sitzungen angewendet. Konten im kostenlosen Tarif 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 – Liste aller Themen mit KI-generierten Erkenntnissen und Sitzungsanzahl
GET /topics/{id} – Abrufen der Details eines spezifischen Themas
POST /topics – Erstellen eines neuen Themas mit Name, Beschreibung, Farbe und Symbol
PATCH /topics/{id} – Aktualisieren der Eigenschaften eines Themas oder des benutzerdefinierten Kontexts
DELETE /topics/{id} – Entfernen eines Themas (Sitzungen werden entkoppelt, nicht gelöscht)
GET /topics/{id}/sessions – Liste aller Sitzungen innerhalb eines Themas
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: Erstellen Sie automatisch Aufgaben in Ihrem PM-Tool aus Sitzungs-Aktionspunkten
Wissensmanagement: Indexieren Sie Sitzungsinhalte in der Wissensdatenbank Ihres Unternehmens
CRM-Integration: Aktualisieren Sie Kundendaten mit Sitzungserkenntnissen
Analyse-Dashboards: Erstellen Sie benutzerdefinierte Berichte über Besprechungsmuster und Produktivität
Workflow-Automatisierung: Lösen Sie Aktionen basierend auf Sitzungsinhalten oder deren Abschluss aus
Zapier-Integration: Verbinden Sie Hedy mit Tausenden von Apps über Zapier (fügen Sie ?format=zapier zu Endpunkten hinzu für Zapier-kompatible flache Array-Antworten)
API-Limits und Best Practices
Rate-Limits: 200 Anfragen pro Minute pro API-Schlüssel
Paginierung: Verwenden Sie den Parameter limit (Standard 50, Max 100) und den Cursor-Parameter after, um durch die Ergebnisse zu blättern
Zwischenspeichern von Antworten, wann immer möglich, um API-Aufrufe zu reduzieren
Fehlerbehandlung mit exponentiellem Backoff
Verwenden Sie Webhooks für Echtzeit-Updates anstelle von Polling
Aufgaben automatisch exportieren
Aktivieren Sie den automatischen Aufgaben-Export, um Aktionspunkte an Ihre integrierten Systeme zu senden:
Aktivieren Sie im Abschnitt API-Zugriff die Option Aufgaben automatisch exportieren
Aufgaben werden automatisch an Ihre konfigurierten Webhook-Endpunkte gesendet
Jede Aufgabe enthält Kontext, Vorschläge für Verantwortliche und Sitzungsreferenzen
Code-Beispiele
Hier ist ein einfaches Beispiel, um Ihre neuesten Sitzungen abzurufen:
curl -X GET "https://api.hedy.bot/v1/sessions?limit=10" \ -H "Authorization: Bearer YOUR_API_KEY"
Weitere Beispiele und die vollständige Endpunkt-Referenz finden Sie in unserer API-Dokumentation.
Fehlerbehebung
401 Unauthorized Error
Überprüfen Sie, ob Ihr API-Schlüssel korrekt und richtig formatiert ist
Stellen Sie sicher, dass Sie ein aktives Pro-Abonnement haben
Prüfen Sie, ob 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 in der Cloud synchronisierte Daten zu
Warten Sie nach der Aufzeichnung einige Minuten, bis die Daten synchronisiert sind
Überprüfen Sie Ihre Datumsfilter und Paginierungsparameter
Überprüfen Sie, ob Sie den richtigen Endpunkt für Ihren Datentyp verwenden
Webhook empfängt keine Ereignisse
Bestätigen Sie, dass Ihre Endpunkt-URL HTTPS verwendet (erforderlich)
Überprüfen Sie, ob Ihr Server mit dem Status 200 OK antwortet
Verifizieren Sie den Header X-Hedy-Signature, falls Sie eine Signatur-Verifizierung implementiert haben
Testen Sie Ihren Webhook mit der Schaltfläche „Webhook testen“
Stellen Sie sicher, dass Firewall-Regeln die Server von Hedy nicht blockieren
Rate-Limit überschritten
Implementieren Sie Caching, um redundante API-Aufrufe zu reduzieren
Nutzen Sie Webhooks für Echtzeit-Updates anstelle von Polling
Führen Sie Operationen nach Möglichkeit im Batch aus
Kontaktieren Sie den Support, wenn Sie höhere Limits benötigen
Profi-Tipp: Verwenden Sie Webhooks anstelle von Polling für Echtzeit-Updates. Dies ist effizienter und bietet sofortige Benachrichtigungen, wenn sich Ihre Daten ändern.
Datenschutz und Sicherheit
Ihre Datensicherheit ist unsere Priorität:
Alle API-Kommunikation erfolgt über HTTPS-Verschlüsselung
API-Schlüssel können jederzeit neu generiert werden (macht den alten Schlüssel ungültig)
Webhook-Nutzlasten werden mit HMAC-SHA256 zur Verifizierung signiert
Daten sind nur mit gültiger Authentifizierung zugänglich
Alle Endpunkte erzwingen strenge Sicherheits-Header
Hilfe erhalten
Für API-spezifische Fragen:
Durchsuchen Sie die API-Dokumentation nach Endpunkt-Details und Schemata
Lesen Sie unseren Blogpost zur API-Ankündigung für Beispiele und Anwendungsfälle
Treten Sie unserer Slack-Community bei, um Support zu erhalten und Ihre Integrationen zu teilen