Skip to main content

Overview

VidNavigator supports two distinct search workflows: global platform search discovers videos on YouTube or TikTok, while semantic (vector) search finds relevant information in already indexed YouTube channel content and uploaded files.

Prerequisites

  • A valid VidNavigator API key.
  • The Python or JavaScript SDK, version 2.1.0 (pip install vidnavigator==2.1.0 or npm install vidnavigator@2.1.0).

Billing

Billing depends on which search you run:
  • Semantic search over indexed content consumes one search_request per call. This includes indexed YouTube channel search and file search (/search/file); file search can also bill analysis_request if the AI analysis pass runs. 1 credit covers 1,000 semantic searches.
  • Global YouTube search (/youtube/search) does not bill search_request. It bills one residential_request per candidate video analyzed, plus a single consolidated analysis_request (ceil(total_tokens / 15000)). See Search YouTube.
  • TikTok keyword search (/tiktok/search) does not bill search_request; it bills per residential page fetched. See TikTok Search.

Searching Videos

Searching Across YouTube

This example searches YouTube for videos that match a query, via the /youtube/search endpoint. The results are ranked with an AI analysis of each video’s transcript.
focus accepts relevance (default), popularity or brevity. You can also filter with end_year and duration (in seconds).
search_videos / searchVideos still work in the 2.1.0 SDKs as deprecated aliases. Use search_youtube / searchYouTube in new code.

Searching Your Uploaded Files

This example searches across the files you have uploaded to VidNavigator. Each result includes namespace_ids and namespaces showing which namespaces the file belongs to, plus the timestamps where the matching content appears.

Filtering File Search by Namespace

You can restrict search to specific namespaces by passing namespace_ids. If omitted, all namespaces are searched.

Next Steps