API v1.0.0

Wisprs API Reference

Versioned public API for Wisprs media ingestion, transcription, exports, and transcript repurposing.

Versioning & deprecation policy: all endpoints live under the current major prefix `/api/v1/`. Breaking changes ship only under a new major prefix; the previous major stays reachable for at least 6 months. Removed or renamed fields are announced in advance and deprecated operations return a `Deprecation` and `Sunset` HTTP header while active.

Base URL: https://wisprs.co/api/v1. The machine-readable spec is served at /api/openapi.yaml and /openapi.json. New to the API? Start with the quickstart guide.

Authentication

Every request is authenticated with a bearer API key (Authorization: Bearer wisprs_sk_…), created from your dashboard API settings. Agent and MCP clients can also use OAuth 2.0 authorization-code flow (PKCE) with these scopes:

transcripts:read — View transcripts and transcription status in your Wisprs workspace.
transcripts:write — Create transcriptions and translations in your Wisprs workspace.
transcripts:export — Export transcripts from your Wisprs workspace.
library:search — Search your Wisprs transcript library.
ai:transform — Generate content from transcripts in your Wisprs workspace.

Endpoints

Full request/response schemas, parameters, and runnable examples for every endpoint are in the interactive reference below.

Media ingestion

POST/api/v1/media/ingestIngest media from a public URL and create a transcription job
POST/api/v1/media/uploads/initInitialize a chunked upload session
POST/api/v1/media/uploads/completeFinalize a chunked upload session and enqueue assembly

Transcriptions

POST/api/v1/transcriptionsCreate a transcription job from a URL source
GET/api/v1/transcriptions/{id}Fetch one transcription
GET/api/v1/transcriptions/{id}/exportExport a transcript in multiple formats
POST/api/v1/transcriptions/{id}/summaryGenerate or fetch a structured summary
POST/api/v1/transcriptions/{id}/chaptersGenerate chapters for a completed transcript
POST/api/v1/transcriptions/{id}/quotesExtract pull-quotes from a completed transcript
POST/api/v1/transcriptions/{id}/repurposeGenerate a repurposed artifact from a transcript

Instant caption transcripts

GET/api/v1/transcriptsGet a video's caption transcript instantly (free)
POST/api/v1/transcriptsGet a video's caption transcript instantly (free, JSON body)

Jobs

GET/api/v1/jobs/{id}Poll transcription job status

Usage

GET/api/v1/usageView API usage and recent request logs for the current key owner

Library search

GET/api/v1/library/searchSearch a user's transcript library

Webhooks

POST/api/v1/webhooks/testSend a signed test webhook to a target URL
GET/api/v1/webhooks/endpointsList configured webhook endpoints
POST/api/v1/webhooks/endpointsCreate a webhook endpoint
PATCH/api/v1/webhooks/endpoints/{id}Update a webhook endpoint
GET/api/v1/webhooks/deliveriesList recent webhook deliveries
POST/api/v1/webhooks/deliveries/{id}/retryRetry a failed webhook delivery

Interactive API reference