Getting Started

This guide will help you get up and running with the YT2Text API in under 5 minutes.

Prerequisites

• A YT2Text account (Sign up here)
• An API key (Get one here)

Base URL

All API requests should be made to:

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

Step 1: Get Your API Key

1. Log in to your YT2Text Dashboard
2. Navigate to API Keys
3. Click "Create New API Key"
4. Copy your key (you'll only see it once!)

Step 2: Process Your First Video

Make a POST request to process a YouTube video:

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

You'll receive a job ID:

{
  "success": true,
  "data": {
    "job_id": "job_abc123def456",
    "status": "queued",
    "estimated_completion": "2025-01-05T15:30:00Z"
  }
}

Step 3: Check Job Status

Poll the status endpoint to check progress:

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

Response:

{
  "success": true,
  "data": {
    "job_id": "job_abc123def456",
    "status": "processing",
    "progress_percentage": 65,
    "current_step": "Generating AI summaries"
  }
}

Step 4: Get Results

Once the job is complete, fetch the results:

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

Response:

{
  "success": true,
  "data": {
    "job_id": "job_abc123def456",
    "status": "completed",
    "video_info": {
      "title": "Rick Astley - Never Gonna Give You Up",
      "channel": "Rick Astley",
      "duration": 213
    },
    "transcript": "Full transcript content here...",
    "summaries": {
      "tldr": "Classic 1987 hit song by Rick Astley...",
      "detailed": "This iconic music video features..."
    }
  }
}

Summary Modes

YT2Text supports 5 AI summary modes:

tldr

detailed

study_notes

timestamped

key_insights

Next Steps

• Learn about Authentication
• Explore the Videos API
• Set up Webhooks
• Check SDK examples