Skip to content

API Overview

In addition to the Claude integration, StoryVault offers a REST API for programmatic access. This lets you integrate sessions, transcripts, and projects into your own systems — for example an intranet, a quality management system, or a reporting solution.

The complete API reference with all endpoints, parameters, and examples is accessible after logging in via the API Documentation menu item.

Every API request requires an API key. The key is sent as a Bearer token in the header:

Authorization: Bearer sv_YOUR_KEY_HERE

Create API keys under Admin → API Keys.

  1. Create an API key

    Admin → API Keys“Create New Key”.

  2. Enter a name and optional expiry date

    Use a descriptive name, e.g. “Intranet Integration” or “Reporting System”.

  3. Copy the key

    The key is shown only once. Store it securely.

API Keys: Creation and management

The API provides access to the main StoryVault resources:

AreaEndpointsDescription
SessionsList, Details, SearchSessions with status, metadata, and summary
TranscriptsRead, DownloadComplete transcripts with speaker attribution
ProjectsList, DetailsProjects with associated sessions
AI ChatList chats, read messagesChat conversations and their history
API KeysCreate, List, RevokeManaging your own API keys

To ensure stable operation for all users, the following limits apply:

LimitValue
Requests per minute per key60
Behavior when exceededHTTP 429 (Too Many Requests)

When you reach the limit, wait briefly and try again. The Retry-After header in the response indicates how long to wait.

The API key is tied to a user and an organization. Access rights correspond to the user’s role:

  • Admins see all data for the organization
  • Other roles see only their own sessions and assigned projects

The API responds with standard HTTP status codes:

CodeMeaning
200Success
400Invalid request (missing or incorrect parameters)
401Not authenticated (missing or invalid key)
403No permission for this resource
404Resource not found
429Rate limit reached
500Server error

Automatic transcript export: An organization automatically exports the transcript to their document management system after each meeting. A script regularly polls for new sessions and downloads the transcripts.

Reporting dashboard: Management integrates StoryVault data into an existing report: number of sessions per month, most common topics, AI usage statistics.

QM software integration: Quality circle minutes are automatically transferred to the QM system. Summaries and action items are immediately available in the existing documentation.

The full developer documentation with endpoints, parameters, request/response formats, and code examples is accessible after logging in via the API Documentation menu item.


This page describes the REST API for programmatic access to StoryVault.