Documentation

Getting Started

Welcome to the GetTranscript documentation. Our API provides powerful tools for extracting YouTube video transcripts.

Overview

GetTranscript offers transcript extraction from YouTube videos.

Universal API - Single endpoint for 1 to 1000+ videos
Background processing - Jobs are processed asynchronously
Multiple formats - txt, srt, vtt, csv, json

Getting an API Key

All requests to GetTranscript require authentication using an API key.

Sign up for an account at gettranscript.app
Choose a subscription plan
Navigate to API Keys section
Create your API key

The API key is visible only after you sign in. Open "API Keys" in your dashboard to create one.

API Usage

Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

curl -H "x-api-key: YOUR_API_KEY" https://gettranscript.app/api/...

Never share your API key or commit it to version control. Use environment variables to store your API key securely.

Base URL

All API endpoints use the following base URL:

https://gettranscript.app/api

Response Format

All API responses are returned in JSON format.

Endpoints

Request Transcripts

POSThttps://gettranscript.app/api/transcript

Request Body:

{
  "videos": ["dQw4w9WgXcQ", "abc123def"],
  "format": "txt"
}

Parameters:

Parameter	Type	Required	Description
`videos`	array	Yes	Array of YouTube video IDs
`format`	string	No	txt, srt, vtt, csv, json (default: txt)

Response:

{
  "success": true,
  "jobId": "api_12345",
  "message": "Transcript job created and queued for processing",
  "details": {
            "totalVideos": 2,
        "format": "txt",
        "status": "pending"
  }
}

Check Status

GEThttps://gettranscript.app/api/transcript/:jobId/status

Response:

{
  "success": true,
  "jobId": "api_12345",
  "status": "processing"
}

Status Values:

pending - Job created, waiting to start
processing - Currently extracting transcripts
completed - Job finished, ready for download
failed - Job failed due to error

Download Results

GEThttps://gettranscript.app/api/transcript/:jobId/download

Download completed transcripts in your chosen format. Returns the transcript content directly.

Rate Limits

Rate Limit: 60 requests per minute per API key
Credits: 1 credit per successfully processed video

Support

Need help? Contact us at support@gettranscript.app