Quickstart

Copy your default API key

Sign up at stophy.dev. New accounts get a default API key automatically, so you can copy or reveal it from the dashboard without creating one first.

export STOPHY_API_KEY="st_YOUR_API_KEY"

Make your first request

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

const res = await fetch("https://api.stophy.dev/v1/video", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    videoUrl: "https://www.youtube.com/watch?v=D7liwdjvhWc",
    type: "transcript",
  }),
});

const json = await res.json();
console.log(json.data);

import os
import httpx

res = httpx.post(
    "https://api.stophy.dev/v1/video",
    headers={
        "Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "videoUrl": "https://www.youtube.com/watch?v=D7liwdjvhWc",
        "type": "transcript",
    },
)

data = res.json()["data"]
print(data)

Read the response

Every successful response uses the same envelope:

{
  "success": true,
  "requestId": "019703a2-e4f1-7b3c-8d9e-f1a2b3c4d5e6",
  "cacheState": "miss",
  "creditsUsed": 1,
  "creditsRemaining": 99,
  "data": { ... }
}

{
  success: true
  requestId: string
  cacheState: "hit" | "miss"
  creditsUsed: number
  creditsRemaining: number
  data: object
}

Try the dashboard path

Open the playground, run the default video request, and confirm the response shows requestId and creditsRemaining.

Use CLI or MCP

CLI:

npx -y @stophy/cli login --browser
stophy video transcript --url "https://www.youtube.com/watch?v=D7liwdjvhWc" --json

Local MCP server:

env STOPHY_API_KEY="$STOPHY_API_KEY" npx -y @stophy/mcp

Hosted MCP endpoint:

https://api.stophy.dev/v1/mcp
Authorization: Bearer $STOPHY_API_KEY

Next steps

Transcripts

Timestamped transcript segments for your app, workflow, or agent.

Search

Search YouTube and return structured results without using a browser.

Concurrency

How many requests you can run in parallel per plan.