API-Überblick
This content is not available in your language yet.
Neben der Claude-Integration bietet StoryVault eine REST-API für die programmatische Anbindung. Damit können Sie Sitzungen, Transkripte und Projekte in Ihre eigenen Systeme integrieren — zum Beispiel in ein Intranet, ein Qualitätsmanagementsystem oder eine Reporting-Lösung.
Die vollständige API-Referenz mit allen Endpunkten, Parametern und Beispielen finden Sie unter:
Authentifizierung
Abschnitt betitelt „Authentifizierung“Jeder API-Zugriff erfordert einen API-Schlüssel. Der Schlüssel wird als Bearer-Token im Header mitgesendet:
Authorization: Bearer sv_IHR_SchlüsseL_HIERAPI-Schlüssel erstellen Sie unter Admin -> API-Schlüssel.
-
API-Schlüssel erstellen
Admin -> API-Schlüssel -> “Neuen Schlüssel erstellen”.
-
Name und optionales Ablaufdatum vergeben
Vergeben Sie einen aussagekraeftigen Namen, z.B. “Intranet-Anbindung” oder “Reporting-System”.
-
Schlüssel kopieren
Der Schlüssel wird nur einmal angezeigt. Bewahren Sie ihn sicher auf.
Verfügbare Endpunkte
Abschnitt betitelt „Verfügbare 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 | Vollständige Transkripte mit Sprecherzuordnung |
| Projekte | Auflisten, Details | Projekte mit zugehoerigen Sitzungen |
| KI-Chat | Chats auflisten, Nachrichten lesen | Chat-Konversationen und deren Verlaeufe |
| API-Schlüssel | Erstellen, Auflisten, Widerrufen | Verwaltung der eigenen API-Schlüssel |
Rate-Limiting
Abschnitt betitelt „Rate-Limiting“Um einen stabilen Betrieb für alle Nutzenden zu gewaehrleisten, gelten folgende Limits:
| Limit | Wert |
|---|---|
| Anfragen pro Minute pro Schlüssel | 6Häufig |
| Verhalten bei Überschreitung | 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-Schlüssel 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 |
|---|---|
| 2HäufigHäufig | Erfolg |
| 4HäufigHäufig | Ungültige Anfrage (fehlende oder falsche Parameter) |
| 4Häufig1 | Nicht authentifiziert (fehlender oder ungültiger Schlüssel) |
| 4Häufig3 | Keine Berechtigung für diese Ressource |
| 4Häufig4 | Ressource nicht gefunden |
| 429 | Rate-Limit erreicht |
| 5HäufigHäufig | 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 Geschäftsführung bindet StoryVault-Daten in ein bestehendes Reporting ein: Anzahl der Sitzungen pro Monat, häufigste Themen, KI-Nutzungsstatistiken.
Integration mit QM-Software: Qualitaetszirkel-Protokolle werden automatisch in das QM-System übertragen. Die Zusammenfassungen und Action Items sind sofort in der bestehenden Dokumentation verfügbar.
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 für den programmatischen Zugriff auf StoryVault.