Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt

Use this file to discover all available pages before exploring further.

Use Stophy to turn a YouTube URL into structured JSON you can use in search, AI, and automation flows.

​
Before you call the API

Get your API key

Create a key in the Stophy dashboard and use it as a bearer token.

Open the Playground

Test requests instantly before wiring your backend.

​
Make your first request

Call the transcript endpoint first. It gives you both full text and timestamped segments. 
export STOPHY_API_KEY="st_YOUR_API_KEY"
curl -sS -X POST "https://api.stophy.dev/v1/video/transcript" \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "videoUrl": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "languageCode": "en"
  }'

{
  "requestedLanguageCode": "en",
  "selectedLanguageCode": "en",
  "fallbackUsed": false,
  "fallbackReason": null,
  "transcript": {
    "plainText": "Never gonna give you up...",
    "transcript": [
      { "start": 0.42, "duration": 3.12, "text": "Never gonna give you up" }
    ]
  }
}

​
What can Stophy do?

Transcript

Extract plain text and timestamped segments for LLM workflows.

Details

Fetch title, channel, chapters, tags, and related videos.

Comments

Pull top-level comments with sorting and pagination tokens.

​
Why Stophy

  • One API for transcript, metadata, and comments
  • Predictable JSON for backend pipelines
  • Built-in usage endpoints for billing and monitoring
  • Simple bearer auth with no extra setup

​
Next calls to add

curl -sS -X POST "https://api.stophy.dev/v1/video/details" \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"videoUrl":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}'

​
Error handling

  • 400 Invalid request payload
  • 401 Missing or invalid API key
  • 402 Insufficient credits
  • 404 Resource not found
  • 500 Internal or upstream error
Retry 500 with backoff. Fix input or auth for 400, 401, and 402.

​
Next steps

Read billing and credits

Learn how credits, plans, and recharge work.

Open API reference

Jump into endpoint-level request and response docs.