API
Developer

API

Build custom integrations with the REST API — create transcriptions, export in 15+ formats, and manage folders.

Key features

REST API v1 Full CRUD operations for transcriptions via REST API.
15+ export formats Export as SRT, VTT, DOCX, PDF, Premiere XML, FCP XML, more.
Webhook notifications Get HTTP callbacks when transcriptions complete.
Token authentication Simple bearer token auth for secure, stateless integration.
Folder management Create and organize transcription folders programmatically at scale.

The HappyScribe API gives developers full programmatic access to transcription, subtitling, and export functionality via a REST interface. Create transcriptions from URLs or file uploads, retrieve results in over 15 export formats, manage folders, and receive webhooks when processing completes. Token-based authentication makes it straightforward to integrate HappyScribe into any application or pipeline.

How it works

Authenticate with your API token (available in your account settings) and make standard HTTP requests to the HappyScribe REST API v1. Submit a media URL or upload a file to create a transcription, then poll for status or register a webhook to be notified when processing completes. Retrieve the finished transcript in any of 15+ export formats, from common formats like SRT and VTT to professional video editing formats like Premiere XML, Final Cut Pro XML, EDL, and Avid DS.

Key capabilities

  • Full CRUD operations — create, read, update, and delete transcriptions programmatically
  • 15+ export formats — SRT, VTT, STL, DOCX, PDF, Premiere XML, FCP XML, EDL, Avid DS, MAXQDA, JSON, CSV, XLSX, and more
  • Webhooks — receive HTTP callbacks when transcriptions complete, avoiding the need to poll
  • Folder management — create, list, and organize folders programmatically for large-scale operations
  • Token authentication — simple bearer token auth for secure, stateless API access

Supported export formats

The API supports an extensive list of export formats to fit any workflow. Subtitle formats include SRT, VTT, and STL. Document exports are available in DOCX, PDF, TXT, JSON, CSV, and XLSX. For video production, you can export in Adobe Premiere XML, Final Cut Pro XML, EDL, and Avid DS formats. Research teams can export in MAXQDA format for qualitative data analysis. This breadth of export options makes the API suitable for media companies, research institutions, accessibility teams, and content production pipelines.

Get started

1

Get your API token

Generate an API token from your HappyScribe account settings page.

2

Create a transcription

Send a POST request with a media URL to create a new transcription and optionally register a webhook.

3

Export the results

Retrieve the finished transcript in any of 15+ formats via the export endpoint.

Explore more integrations

Browse all integrations