Skip to main content
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
}
'
{
  "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>"
        ]
      }
    }
  }
}

Documentation Index

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

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

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.

​
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"
  }'

​
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?"
  }'

​
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.

Response

Video analyzed successfully

​
status
enum<string>
Available options:
success
​
data
object