Analyze online video

curl --request POST \
  --url https://api.vidnavigator.com/v1/analyze/video \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
  "query": "What is the main topic discussed?",
  "transcript_text": false,
  "include_usage": false
}
'

import requests

url = "https://api.vidnavigator.com/v1/analyze/video"

payload = {
    "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
    "query": "What is the main topic discussed?",
    "transcript_text": False,
    "include_usage": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    video_url: 'https://youtube.com/watch?v=dQw4w9WgXcQ',
    query: 'What is the main topic discussed?',
    transcript_text: false,
    include_usage: false
  })
};

fetch('https://api.vidnavigator.com/v1/analyze/video', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vidnavigator.com/v1/analyze/video",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'video_url' => 'https://youtube.com/watch?v=dQw4w9WgXcQ',
    'query' => 'What is the main topic discussed?',
    'transcript_text' => false,
    'include_usage' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vidnavigator.com/v1/analyze/video"

	payload := strings.NewReader("{\n  \"video_url\": \"https://youtube.com/watch?v=dQw4w9WgXcQ\",\n  \"query\": \"What is the main topic discussed?\",\n  \"transcript_text\": false,\n  \"include_usage\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vidnavigator.com/v1/analyze/video")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"https://youtube.com/watch?v=dQw4w9WgXcQ\",\n  \"query\": \"What is the main topic discussed?\",\n  \"transcript_text\": false,\n  \"include_usage\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vidnavigator.com/v1/analyze/video")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"video_url\": \"https://youtube.com/watch?v=dQw4w9WgXcQ\",\n  \"query\": \"What is the main topic discussed?\",\n  \"transcript_text\": false,\n  \"include_usage\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "video_info": {
      "title": "<string>",
      "description": "<string>",
      "thumbnail": "<string>",
      "url": "<string>",
      "channel": "<string>",
      "channel_url": "<string>",
      "duration": 123,
      "views": 123,
      "likes": 123,
      "published_date": "<string>",
      "keywords": [
        "<string>"
      ],
      "category": "<string>",
      "available_languages": [
        "<string>"
      ],
      "selected_language": "<string>",
      "carousel_info": {
        "total_items": 123,
        "video_count": 123,
        "image_count": 123,
        "selected_index": 123
      }
    },
    "transcript": [
      {
        "text": "<string>",
        "start": 123,
        "end": 123
      }
    ],
    "transcript_analysis": {
      "summary": "<string>",
      "people": [
        {
          "name": "<string>",
          "context": "<string>"
        }
      ],
      "places": [
        {
          "name": "<string>",
          "context": "<string>"
        }
      ],
      "key_subjects": [
        {
          "name": "<string>",
          "description": "<string>",
          "importance": "<string>"
        }
      ],
      "timestamp": 123,
      "relevant_text": "<string>",
      "query_answer": {
        "answer": "<string>",
        "best_segment_index": 123,
        "relevant_segments": [
          "<string>"
        ]
      }
    }
  },
  "usage": {
    "charges": [
      {
        "quantity": 123,
        "credits": 123,
        "waived": true,
        "credits_saved": 123,
        "tokens": {
          "prompt_tokens": 123,
          "completion_tokens": 123,
          "total_tokens": 123
        }
      }
    ],
    "total_credits": 123,
    "waived": {
      "credits_saved": 123
    }
  }
}

{
  "status": "error",
  "error": "<string>",
  "message": "<string>"
}

{
  "status": "error",
  "error": "limit_exceeded",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "error",
  "error": "internal_server_error",
  "message": "<string>"
}

Online media

Analyze Video

Analyze an online video and return comprehensive analysis results with intelligent caching.

Behavior:

If no query provided: Returns summary analysis (cached if available)
If query provided: Returns both summary (from cache if available) and fresh question analysis

Caching:

Summary analyses are cached and reused
Question/query analyses are not cached (always fresh)
Transcripts are cached for optimization

Billing: analysis_request is token-based — quantity = ceil(total_tokens / 15000). One unit is charged up front as a credit gate; additional units are topped up at the end if the LLM call exceeded 15,000 tokens. When the transcript isn’t cached, one additional residential_request or standard_request is charged for the fetch (residential for YouTube/Instagram/Facebook-watch/Rumble, standard otherwise). Set include_usage=true to receive the per-charge breakdown — the consolidated analysis_request entry carries a nested tokens object with prompt_tokens/completion_tokens/total_tokens.

Optional: set transcript_text=true to return the transcript as a single text string instead of an array of segments.

POST

analyze

video

Analyze online video

curl --request POST \
  --url https://api.vidnavigator.com/v1/analyze/video \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
  "query": "What is the main topic discussed?",
  "transcript_text": false,
  "include_usage": false
}
'

import requests

url = "https://api.vidnavigator.com/v1/analyze/video"

payload = {
    "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
    "query": "What is the main topic discussed?",
    "transcript_text": False,
    "include_usage": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    video_url: 'https://youtube.com/watch?v=dQw4w9WgXcQ',
    query: 'What is the main topic discussed?',
    transcript_text: false,
    include_usage: false
  })
};

fetch('https://api.vidnavigator.com/v1/analyze/video', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vidnavigator.com/v1/analyze/video",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'video_url' => 'https://youtube.com/watch?v=dQw4w9WgXcQ',
    'query' => 'What is the main topic discussed?',
    'transcript_text' => false,
    'include_usage' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vidnavigator.com/v1/analyze/video"

	payload := strings.NewReader("{\n  \"video_url\": \"https://youtube.com/watch?v=dQw4w9WgXcQ\",\n  \"query\": \"What is the main topic discussed?\",\n  \"transcript_text\": false,\n  \"include_usage\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vidnavigator.com/v1/analyze/video")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"https://youtube.com/watch?v=dQw4w9WgXcQ\",\n  \"query\": \"What is the main topic discussed?\",\n  \"transcript_text\": false,\n  \"include_usage\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vidnavigator.com/v1/analyze/video")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"video_url\": \"https://youtube.com/watch?v=dQw4w9WgXcQ\",\n  \"query\": \"What is the main topic discussed?\",\n  \"transcript_text\": false,\n  \"include_usage\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "video_info": {
      "title": "<string>",
      "description": "<string>",
      "thumbnail": "<string>",
      "url": "<string>",
      "channel": "<string>",
      "channel_url": "<string>",
      "duration": 123,
      "views": 123,
      "likes": 123,
      "published_date": "<string>",
      "keywords": [
        "<string>"
      ],
      "category": "<string>",
      "available_languages": [
        "<string>"
      ],
      "selected_language": "<string>",
      "carousel_info": {
        "total_items": 123,
        "video_count": 123,
        "image_count": 123,
        "selected_index": 123
      }
    },
    "transcript": [
      {
        "text": "<string>",
        "start": 123,
        "end": 123
      }
    ],
    "transcript_analysis": {
      "summary": "<string>",
      "people": [
        {
          "name": "<string>",
          "context": "<string>"
        }
      ],
      "places": [
        {
          "name": "<string>",
          "context": "<string>"
        }
      ],
      "key_subjects": [
        {
          "name": "<string>",
          "description": "<string>",
          "importance": "<string>"
        }
      ],
      "timestamp": 123,
      "relevant_text": "<string>",
      "query_answer": {
        "answer": "<string>",
        "best_segment_index": 123,
        "relevant_segments": [
          "<string>"
        ]
      }
    }
  },
  "usage": {
    "charges": [
      {
        "quantity": 123,
        "credits": 123,
        "waived": true,
        "credits_saved": 123,
        "tokens": {
          "prompt_tokens": 123,
          "completion_tokens": 123,
          "total_tokens": 123
        }
      }
    ],
    "total_credits": 123,
    "waived": {
      "credits_saved": 123
    }
  }
}

{
  "status": "error",
  "error": "<string>",
  "message": "<string>"
}

{
  "status": "error",
  "error": "limit_exceeded",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "error",
  "error": "internal_server_error",
  "message": "<string>"
}

Get comprehensive AI-powered analysis of online videos including summaries, key insights, and structured data extraction.

Overview

Transform any online video into structured insights with our advanced AI analysis. Extract summaries, identify people and places, generate key topics, and ask specific questions about the content.

Analysis Capabilities

Content Summary

AI-generated summaries highlighting key points and themes

Entity Extraction

Identify people, places, organizations, and concepts mentioned

Topic Analysis

Extract main topics, themes, and discussion points

Question Answering

Ask specific questions about the video content

Intelligent Caching

Summary analyses are cached and reused for efficiency
Question/query analyses are always fresh and never cached
Transcripts are cached to optimize performance

Billing

Analysis consumes analysis_request units based on context size. One unit covers up to 15,000 total tokens, and longer contexts are billed with ceil(total_tokens / 15000). For example, an analysis that uses 17,000 total tokens consumes 2 analysis_request units. One unit is charged up front as a credit gate; additional units are topped up at the end if the LLM call exceeded 15,000 tokens. When the transcript isn’t cached, one additional residential_request or standard_request is charged for the fetch (residential for YouTube/Instagram/Facebook-watch/Rumble, standard otherwise). Set include_usage: true to receive a usage block with the per-charge breakdown — the consolidated analysis_request entry carries a nested tokens object with prompt_tokens / completion_tokens / total_tokens.

Example Usage

Basic Analysis (Summary Only)

curl -X POST "https://api.vidnavigator.com/v1/analyze/video" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ"
  }'

import requests

url = "https://api.vidnavigator.com/v1/analyze/video"
headers = {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ"
}

response = requests.post(url, headers=headers, json=data)
analysis = response.json()

print("Summary:", analysis['data']['transcript_analysis']['summary'])
print("Key Topics:", analysis['data']['transcript_analysis']['key_topics'])

const response = await fetch('https://api.vidnavigator.com/v1/analyze/video', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    video_url: 'https://youtube.com/watch?v=dQw4w9WgXcQ'
  })
});

const analysis = await response.json();

Analysis with Custom Question

curl -X POST "https://api.vidnavigator.com/v1/analyze/video" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
    "query": "What is the main topic discussed and who are the key speakers?"
  }'

import requests

url = "https://api.vidnavigator.com/v1/analyze/video"
headers = {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
    "query": "What is the main topic discussed and who are the key speakers?"
}

response = requests.post(url, headers=headers, json=data)
analysis = response.json()

# Get both summary and question-specific analysis
summary = analysis['data']['transcript_analysis']['summary']
question_answer = analysis['data']['transcript_analysis']['question_analysis']

Response Example

Basic Analysis Response

{
  "status": "success",
  "data": {
    "video_info": {
      "title": "How to Build a Startup",
      "description": "A comprehensive guide to building a startup from scratch.",
      "thumbnail": "https://example.com/thumbnail.jpg",
      "url": "https://youtube.com/watch?v=example123",
      "channel": "TechTalks",
      "duration": 1530.0,
      "views": 150000,
      "likes": 4500,
      "published_date": "2023-05-10",
      "keywords": ["startup", "entrepreneurship", "business"],
      "category": "Education"
    },
    "transcript": [
      {
        "text": "Welcome to today's discussion on building startups...",
        "start": 0.0,
        "end": 4.2
      }
    ],
    "transcript_analysis": {
      "summary": "This video covers essential startup building strategies including market validation, team building, and funding approaches. The speaker emphasizes the importance of customer feedback and iterative development.",
      "key_topics": [
        "Market validation",
        "Team building", 
        "Funding strategies",
        "Customer feedback",
        "Product development"
      ],
      "people": [
        {
          "name": "Sarah Johnson",
          "context": "CEO and founder discussing her startup journey"
        }
      ],
      "places": [
        {
          "name": "Silicon Valley", 
          "context": "Mentioned as a startup hub"
        }
      ],
      "sentiment": "positive",
      "category": "business_education"
    }
  }
}

Analysis with Question Response

{
  "status": "success",
  "data": {
    "transcript_analysis": {
      "summary": "...",
      "question_analysis": {
        "question": "What is the main topic discussed and who are the key speakers?",
        "answer": "The main topic is startup building strategies with focus on market validation and customer development. The key speaker is Sarah Johnson, CEO of TechCorp, who shares insights from her 5-year entrepreneurial journey.",
        "confidence": 0.92,
        "relevant_segments": [
          {
            "text": "Hi, I'm Sarah Johnson, CEO of TechCorp...",
            "start": 15.0,
            "end": 25.0
          }
        ]
      }
    }
  }
}

Use Cases

Content Research

Quickly understand video content without watching entire videos

Knowledge Extraction

Extract structured data from educational or training content

Content Moderation

Analyze content for compliance and safety requirements

Learning Platforms

Create summaries and study materials from video lectures

Authorizations

X-API-Key

string

header

required

API key authentication. Include your VidNavigator API key in the X-API-Key header.

Body

application/json

video_url

string<uri>

required

URL of the video to analyze

Example:

"https://youtube.com/watch?v=dQw4w9WgXcQ"

query

string

Optional question about the video content

Example:

"What is the main topic discussed?"

transcript_text

boolean

default:false

When true, returns the transcript as a single plain-text string instead of an array of segments.

include_usage

boolean

default:false

When true, the response includes a usage block listing every meter charged during this request, the total credits deducted, and the user's remaining balance.

Response

Video analyzed successfully

status

enum<string>

Available options:

success

data

object

Show child attributes

usage

object

Per-call usage disclosure. Returned only when the caller passes include_usage=true in the request body. Lists every meter that fired during this request and the credits actually deducted. Multiple charges of the same meter inside one request are consolidated into a single entry (their quantities and credits are summed). When a charge was waived through a cache-hit sponsorship (e.g. NGO), it carries waived: true + credits_saved, and a top-level waived.credits_saved summary appears.

For endpoints that involve LLM analysis (/extract/video, /extract/file, /analyze/video, /analyze/file, /youtube/search), the consolidated analysis_request charge entry carries a nested tokens object reporting the LLM input/output token tally for the request.

Show child attributes

API Documentation

Online media

Local Files

System

Analyze Video

Overview

Analysis Capabilities

Content Summary

Entity Extraction

Topic Analysis

Question Answering

Intelligent Caching

Billing

Example Usage

Basic Analysis (Summary Only)

Analysis with Custom Question

Response Example

Basic Analysis Response

Analysis with Question Response

Use Cases

Content Research

Knowledge Extraction

Content Moderation

Learning Platforms

Authorizations

Body

Response

​Overview

​Analysis Capabilities

Content Summary

Entity Extraction

Topic Analysis

Question Answering

​Intelligent Caching

​Billing

​Example Usage

​Basic Analysis (Summary Only)

​Analysis with Custom Question

​Response Example

​Basic Analysis Response

​Analysis with Question Response

​Use Cases

Content Research

Knowledge Extraction

Content Moderation

Learning Platforms

Authorizations

Body

Response

Overview

Analysis Capabilities

Intelligent Caching

Billing

Example Usage

Basic Analysis (Summary Only)

Analysis with Custom Question

Response Example

Basic Analysis Response

Analysis with Question Response

Use Cases