Getting Started

This guide covers the current public API surface at

https://api.yt2text.cc/api/v1

Before You Start

Create a YT2Text account
Generate an API key from the dashboard
Use the public API only for developer integrations

The public developer API and the web app's internal API are different surfaces. External integrations should stay on

/api/v1/*

Base URL

https://api.yt2text.cc/api/v1

Authentication

Pass your API key on every request:

Authorization: Bearer sk_your_api_key

X-API-Key: sk_your_api_key

Process Your First Video

curl -X POST https://api.yt2text.cc/api/v1/videos/process \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "options": {
      "summary_modes": ["tldr"]
    }
  }'

Example response:

{
  "success": true,
  "data": {
    "job_id": "uuid",
    "video_id": "dQw4w9WgXcQ",
    "status": "queued",
    "estimated_completion": "2026-03-22T12:00:00Z"
  }
}

Check Status

curl https://api.yt2text.cc/api/v1/videos/status/uuid \
  -H "Authorization: Bearer sk_your_api_key"

Get Results

curl https://api.yt2text.cc/api/v1/videos/result/uuid \
  -H "Authorization: Bearer sk_your_api_key"

Supported Summary Modes

Current modes:

```
tldr
```
```
detailed
```
```
study_notes
```
```
timestamped
```
```
key_insights
```

Plan behavior:

Free:
```
tldr
```
only
Plus: all five modes
Pro: all five modes plus webhooks, custom prompts, batch, infographics, AI chat, PDF export, and priority queue

Important Caveats

```
/api/v1/auth/*
```
manages API keys; it is not a public login/signup API.
Usage endpoints exist, but currently return placeholder/mock analytics payloads.
Webhook URLs are supported for Pro jobs, but the public API does not currently expose webhook secret management.