API-Ueberblick
Neben der Claude-Integration bietet StoryVault eine REST-API fuer die programmatische Anbindung. Damit koennen Sie Sitzungen, Transkripte und Projekte in Ihre eigenen Systeme integrieren — zum Beispiel in ein Intranet, ein Qualitaetsmanagementsystem oder eine Reporting-Loesung.
Die vollstaendige API-Referenz mit allen Endpunkten, Parametern und Beispielen finden Sie unter:
Authentifizierung
Abschnitt betitelt „Authentifizierung“Jeder API-Zugriff erfordert einen API-Schluessel. Der Schluessel wird als Bearer-Token im Header mitgesendet:
Authorization: Bearer sv_IHR_SCHLUESSEL_HIERAPI-Schluessel erstellen Sie unter Admin -> API-Schluessel.
-
API-Schluessel erstellen
Admin -> API-Schluessel -> “Neuen Schluessel erstellen”.
-
Name und optionales Ablaufdatum vergeben
Vergeben Sie einen aussagekraeftigen Namen, z.B. “Intranet-Anbindung” oder “Reporting-System”.
-
Schluessel kopieren
Der Schluessel wird nur einmal angezeigt. Bewahren Sie ihn sicher auf.
Verfuegbare Endpunkte
Abschnitt betitelt „Verfuegbare Endpunkte“Die API bietet Zugriff auf die wichtigsten StoryVault-Ressourcen:
| Bereich | Endpunkte | Beschreibung |
|---|---|---|
| Sitzungen | Auflisten, Details, Suche | Sitzungen mit Status, Metadaten und Summary |
| Transkripte | Lesen, Herunterladen | Vollstaendige Transkripte mit Sprecherzuordnung |
| Projekte | Auflisten, Details | Projekte mit zugehoerigen Sitzungen |
| KI-Chat | Chats auflisten, Nachrichten lesen | Chat-Konversationen und deren Verlaeufe |
| API-Schluessel | Erstellen, Auflisten, Widerrufen | Verwaltung der eigenen API-Schluessel |
Rate-Limiting
Abschnitt betitelt „Rate-Limiting“Um einen stabilen Betrieb fuer alle Nutzenden zu gewaehrleisten, gelten folgende Limits:
| Limit | Wert |
|---|---|
| Anfragen pro Minute pro Schluessel | 60 |
| Verhalten bei Ueberschreitung | HTTP 429 (Too Many Requests) |
Wenn Sie das Limit erreichen, warten Sie kurz und versuchen Sie es erneut. Der Retry-After-Header in der Antwort gibt an, wie lange Sie warten sollten.
Zugriffskontrolle
Abschnitt betitelt „Zugriffskontrolle“Der API-Schluessel ist an einen Nutzenden und eine Organisation gebunden. Die Zugriffsrechte entsprechen der Rolle des Nutzenden:
- Admins sehen alle Daten der Organisation
- Andere Rollen sehen nur die eigenen Sitzungen und zugewiesenen Projekte
Fehler-Responses
Abschnitt betitelt „Fehler-Responses“Die API antwortet mit Standard-HTTP-Statuscodes:
| Code | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Ungueltige Anfrage (fehlende oder falsche Parameter) |
| 401 | Nicht authentifiziert (fehlender oder ungueltiger Schluessel) |
| 403 | Keine Berechtigung fuer diese Ressource |
| 404 | Ressource nicht gefunden |
| 429 | Rate-Limit erreicht |
| 500 | Serverfehler |
Praxis-Beispiele
Abschnitt betitelt „Praxis-Beispiele“Automatischer Export von Transkripten: Ein Traeger exportiert nach jedem Meeting automatisch das Transkript in sein Dokumentenmanagementsystem. Ein Skript fragt regelmaessig neue Sitzungen ab und laedt die Transkripte herunter.
Reporting-Dashboard: Die Geschaeftsfuehrung bindet StoryVault-Daten in ein bestehendes Reporting ein: Anzahl der Sitzungen pro Monat, haeufigste Themen, KI-Nutzungsstatistiken.
Integration mit QM-Software: Qualitaetszirkel-Protokolle werden automatisch in das QM-System uebertragen. Die Zusammenfassungen und Action Items sind sofort in der bestehenden Dokumentation verfuegbar.
API-Dokumentation
Abschnitt betitelt „API-Dokumentation“Die interaktive API-Dokumentation mit allen Details zu Endpunkten, Parametern, Request-/Response-Formaten und Code-Beispielen finden Sie unter:
Alternativ ist die API-Dokumentation auch innerhalb von StoryVault unter dem Menuepunkt API-Dokumentation erreichbar (erfordert Login).
Weiterführend
Abschnitt betitelt „Weiterführend“Diese Seite beschreibt die REST-API fuer den programmatischen Zugriff auf StoryVault.