Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.veedcrawl.com/llms.txt

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

Veedcrawl’s API follows a simple pattern: send a video URL, get back structured data. This guide walks you through your first three calls — metadata (free, instant), transcript (async, 1–5 credits), and extract (async, 10 credits) — so you understand how the whole flow works before you build anything.
1

Sign up and get your API key

Go to veedcrawl.com/login and create a free account. Every new account receives 50 free credits — no credit card required.After signing in, copy your API key from the dashboard. It starts with ma_. Keep it somewhere safe; you’ll pass it as a header on every /v1/* request.
2

Check that the API is up

The /health endpoint requires no authentication. Use it to confirm the API is reachable before adding your key.
curl "https://api.veedcrawl.com/health"

{ "status": "ok" }
3

Fetch metadata for a public video

Metadata is free and returns immediately — no polling needed. Pass the video URL as a query parameter and your API key in the x-api-key header.
curl "https://api.veedcrawl.com/v1/metadata?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \
  -H "x-api-key: YOUR_KEY"
You’ll receive a normalized object regardless of which platform the URL is from:
{
  "platform": "youtube",
  "title": "Rick Astley - Never Gonna Give You Up",
  "author": "Rick Astley",
  "duration": 213,
  "viewCount": 1400000000,
  "likeCount": 15000000,
  "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg"
}
Use metadata as a cheap first pass on any video before deciding whether to spend credits on transcript or extract.
4

Get a transcript

Transcription is asynchronous. You enqueue a job, get back a jobId, then poll until the status is completed.Enqueue the job:
curl -X POST "https://api.veedcrawl.com/v1/transcript" \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "mode": "auto"}'

{ "jobId": "job_abc123", "status": "queued" }
Poll for the result:
curl "https://api.veedcrawl.com/v1/transcript/job_abc123" \
  -H "x-api-key: YOUR_KEY"
Keep polling until status is completed or failed. A typical transcript job finishes in under 30 seconds.
{
  "jobId": "job_abc123",
  "status": "completed",
  "resultJson": {
    "text": "Never gonna give you up, never gonna let you down..."
  }
}
The mode parameter controls the transcription source: native uses platform captions only, generate uses AI speech-to-text only, and auto tries native captions first and falls back to AI if none are available.
Native captions cost 1 credit. AI-generated transcription costs 5 credits.
5

Extract structured information with a prompt (optional)

Extract lets you ask any question about a video and get a structured answer back. It follows the same enqueue-and-poll pattern as transcript.Enqueue the job:
curl -X POST "https://api.veedcrawl.com/v1/extract" \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "prompt": "Extract the hook, main message, and any call to action"
  }'

{ "jobId": "job_xyz456", "status": "queued" }
Poll for the result:
curl "https://api.veedcrawl.com/v1/extract/job_xyz456" \
  -H "x-api-key: YOUR_KEY"

{
  "jobId": "job_xyz456",
  "status": "completed",
  "resultJson": {
    "hook": "Opens with the artist walking toward the camera on a city street",
    "mainMessage": "A declaration of unwavering loyalty and commitment",
    "callToAction": "None — the video ends on the chorus"
  }
}
Extract costs 10 credits per job. You can optionally pass a schema field with a JSON Schema object to enforce the exact shape of resultJson.

​
Next steps

Authentication

Learn how to manage API keys and understand auth errors.

MCP server

Add Veedcrawl tools to Claude, Cursor, or any MCP-compatible host.

Creator audit guide

Run a full creator audit using only a username — no video URLs needed.