Hedy API

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 Moeglichkeit, Hedys Funktionen ueber die App hinaus zu erweitern. Alle API-Funktionen erfordern ein Pro-Abonnement mit aktiviertem Cloud Sync.

Erste Schritte mit der API

1. Oeffnen Sie die Hedy-App und navigieren Sie zu Account Settings

2. Scrollen Sie zum Bereich API Access

3. Klicken Sie auf Generate New API Key (Pro-Abonnement erforderlich)

4. Kopieren Sie Ihren API Key und bewahren Sie ihn sicher auf - Sie koennen ihn nicht erneut einsehen

5. Besuchen Sie unsere API-Dokumentation auf SwaggerHub fuer detaillierte Endpoint-Informationen, oder greifen Sie auf die OpenAPI-Spezifikation unter https://api.hedy.bot/v1/docs zu

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

API-Funktionen

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

• Sessions: Listen und Abrufen Ihrer Meeting-Sitzungen, einschliesslich vollstaendiger Transkripte, KI-Zusammenfassungen und Kernpunkte

• Highlights: Abrufen wichtiger Momente aus Ihren Meetings mit KI-generierten Erkenntnissen

• Topics: Erstellen, Aktualisieren, Loeschen und Organisieren von Sitzungen nach Themen mit benutzerdefinierten Kontextanweisungen

• Todos: Abrufen und Verwalten von Aufgaben ueber alle Sitzungen hinweg

• Session Contexts: Erstellen und Verwalten wiederverwendbarer Anweisungen, die steuern, wie Hedy Ihre Meetings analysiert

• Webhooks: Konfigurieren und Verwalten von Webhook-Endpoints ueber die API fuer Echtzeit-Ereignisbenachrichtigungen

• User Info: Abrufen Ihrer Kontodetails ueber den /me-Endpoint

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit Ihrem API Key. Fuegen 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:

1. Klicken Sie im Bereich API Access auf Manage Webhooks

2. Klicken Sie auf die +-Schaltflaeche, um einen neuen Webhook hinzuzufuegen

3. Geben Sie Ihre HTTPS-Endpoint-URL ein

4. Waehlen Sie die Ereignisse, die Sie empfangen moechten:

   • session.created - Wenn eine neue Aufnahmesitzung startet

   • session.ended - Wenn eine Aufnahmesitzung die Verarbeitung abschliesst

   • session.exported - Wenn eine Sitzung manuell vom Nutzer exportiert wird

   • highlight.created - Wenn ein neues Highlight hinzugefuegt wird

   • todo.exported - Wenn Aufgaben aus einer Sitzung exportiert werden

5. Speichern Sie Ihren Webhook und notieren Sie das Signing Secret fuer die Payload-Verifizierung

Sie koennen Webhooks auch programmatisch ueber 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 enthaelt eine Signatur im X-Hedy-Signature-Header, damit Sie verifizieren koennen, 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 Authentizitaet sicherzustellen. Jede Zustellung enthaelt auch einen X-Hedy-Event-Header, der den Ereignistyp angibt (z.B. session.ended).

Session Contexts

Session Contexts ermoeglichen es Ihnen, wiederverwendbare Anweisungen zu erstellen, die Hedy mitteilen, wie Ihre Meetings analysiert werden sollen. Sie koennten beispielsweise einen Kontext fuer “Vertriebsgespraeche” erstellen, der sich auf Aufgaben und Kundeneinwaende konzentriert, oder einen fuer “Standup-Meetings”, der Blocker und Updates verfolgt.

Verwalten Sie Ihre Session Contexts ueber 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 beschraenkt.

Topics ueber die API verwalten

Topics helfen Ihnen, Ihre Sitzungen in Kategorien zu organisieren. Die API unterstuetzt die vollstaendige 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 und Symbol erstellen

• PATCH /topics/{id} - Eigenschaften oder benutzerdefinierten Kontext eines Topics aktualisieren

• DELETE /topics/{id} - Ein Topic entfernen (Sitzungen werden entkoppelt, nicht geloescht)

• GET /topics/{id}/sessions - Alle Sitzungen innerhalb eines Topics auflisten

Topics koennen ein topicContext-Feld mit benutzerdefinierten Anweisungen (bis zu 20.000 Zeichen) enthalten, die steuern, wie Hedy dem Topic zugeordnete Sitzungen analysiert.

Haeufige Anwendungsfaelle

• Projektmanagement-Integration: Automatisch Aufgaben in Ihrem PM-Tool aus Meeting-Aktionspunkten erstellen

• Wissensmanagement: Meeting-Inhalte in der Wissensdatenbank Ihres Unternehmens indizieren

• CRM-Integration: Kundeneintraege mit Meeting-Erkenntnissen aktualisieren

• Analyse-Dashboards: Benutzerdefinierte Berichte ueber Meeting-Muster und Produktivitaet erstellen

• Workflow-Automatisierung: Aktionen basierend auf Meeting-Inhalten oder -Abschluss ausloesen

• Zapier-Integration: Hedy mit Tausenden von Apps ueber Zapier verbinden (fuegen Sie ?format=zapier an Endpoints fuer 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 blaettern

• Cachen Sie Antworten nach Moeglichkeit, um API-Aufrufe zu reduzieren

• Behandeln Sie Fehler elegant mit exponentiellem Backoff

• Verwenden Sie Webhooks fuer Echtzeit-Updates anstelle von Polling

Automatischer Aufgabenexport

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

1. Aktivieren Sie im Bereich API Access Auto Export Todos

2. Aufgaben werden automatisch an Ihre konfigurierten Webhook-Endpoints gesendet

3. Jede Aufgabe enthaelt Kontext, Zuweisungsvorschlaege und Meeting-Referenz

Code-Beispiele

Hier 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"

Weitere Beispiele und die vollstaendige Endpoint-Referenz finden Sie in unserer API-Dokumentation.

Fehlerbehebung

401 Unauthorized Error

• Pruefen Sie, ob Ihr API Key korrekt und richtig formatiert ist

• Stellen Sie sicher, dass Sie ein aktives Pro-Abonnement haben

• Pruefen Sie, ob Cloud Sync in Ihrem Konto aktiviert ist

• Bestaetigen Sie, dass der API Key nicht neu generiert wurde (alte Keys werden ungueltig)

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 Aufnahme einige Minuten, bis die Daten synchronisiert sind

• Pruefen Sie Ihre Datumsfilter und Paginierungsparameter

• Stellen Sie sicher, dass Sie den richtigen Endpoint fuer Ihren Datentyp verwenden

Webhook empfaengt keine Ereignisse

• Bestaetigen Sie, dass Ihre Endpoint-URL HTTPS verwendet (erforderlich)

• Pruefen Sie, ob Ihr Server mit dem Statuscode 200 OK antwortet

• Ueberpruefen Sie den X-Hedy-Signature-Header, wenn Sie Signaturverifizierung implementieren

• Testen Sie Ihren Webhook mit der Schaltflaeche “Test Webhook”

• Pruefen Sie, ob Firewall-Regeln Hedys Server blockieren

Rate-Limit ueberschritten

• Implementieren Sie Caching, um redundante API-Aufrufe zu reduzieren

• Verwenden Sie Webhooks fuer Echtzeit-Updates statt Polling

• Buendeln Sie Operationen nach Moeglichkeit

• Kontaktieren Sie den Support, wenn Sie hoehere Limits benoetigen

Profi-Tipp: Verwenden Sie Webhooks statt Polling fuer Echtzeit-Updates. Dies ist effizienter und bietet sofortige Benachrichtigungen, wenn sich Ihre Daten aendern.

Datenschutz und Sicherheit

Die Sicherheit Ihrer Daten hat fuer uns Prioritaet:

• Alle API-Kommunikation verwendet HTTPS-Verschluesselung

• API Keys koennen jederzeit neu generiert werden (alte Keys werden ungueltig)

• Webhook-Payloads werden mit HMAC-SHA256 zur Verifizierung signiert

• Daten sind nur mit gueltiger Authentifizierung zugaenglich

• Alle Endpoints erzwingen strenge Security-Header

Hilfe erhalten

Fuer API-spezifische Fragen:

• Durchsuchen Sie die API-Dokumentation fuer Endpoint-Details und Schemas

• Lesen Sie unseren API-Ankuendigungs-Blogpost fuer Beispiele und Anwendungsfaelle

• Treten Sie unserer Slack-Community bei fuer Support und zum Teilen Ihrer Integrationen