Documentation

Build with Vidsight

The API lets you request analyses and read reports from your own tools. Every request uses a bearer token from your account settings.

Quick start

Create an API key in your account settings, then send a request with any public video URL.

curl -X POST https://api.example.com/v1/analyze \
  -H "Authorization: Bearer $VIDSIGHT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.youtube.com/watch?v=VIDEO_ID"}'

Analyze a video

A request returns an analysis ID. Most analyses finish within a minute. Poll the status endpoint, or register a webhook to be notified when the report is ready.

{
  "id": "an_8f2c1d",
  "status": "queued",
  "created_at": "2026-10-14T20:12:00Z"
}

Check progress with GET /v1/analyses/{id}. A finished analysis includes the retention curve, chapter scores and a sentiment summary.

Rate limits

• Free: 3 analyses per calendar month.
• Pro: 100 analyses per calendar month.
• Team: no monthly cap, up to 10 analyses in progress at once.

Errors

• 400 invalid_url: the link is not a public YouTube video.
• 401 unauthorized: the API key is missing or was revoked.
• 429 rate_limited: a monthly or concurrency limit was reached.