Skip to Content

Quickstart

Get up and running with the VidNavigator API in less than 5 minutes.

This guide will walk you through the essential steps to start using the VidNavigator API with our official SDKs.

Step 1: Get Your API Key

First, you'll need an API key. Sign up for a free account on the VidNavigator Developer Dashboard to get your key.

Keep this key safe, as you'll need it to authenticate all of your API requests.

Step 2: Install an SDK

We provide official SDKs for Python and JavaScript/TypeScript. These docs cover version 2.1.0.

pip install vidnavigator==2.1.0

Python SDK

Available on PyPI.

JavaScript SDK

Available on npm.

Then expose your key as an environment variable. Both SDKs read it from there:

export VIDNAVIGATOR_API_KEY="your_api_key_here"

Step 3: Make Your First API Call

Now you're ready to make your first API call. Here's a simple example that retrieves the transcript of a YouTube video. You can also use the Postman collection to make your first API call.

Run In Postman

VidNavigator uses a single transcript method for every platform. Use get_transcript for YouTube, TikTok, X/Twitter, Facebook, Vimeo, and more — the endpoint auto-detects the platform from the URL.

from vidnavigator import VidNavigatorClient, VidNavigatorError

client = VidNavigatorClient()  # reads VIDNAVIGATOR_API_KEY

try:
    # Works for YouTube and every other supported platform
    result = client.get_transcript(
        video_url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    )
    print("Successfully retrieved transcript for:", result.data.video_info.title)
    print("Transcript snippet:", result.data.transcript[0].text)
except VidNavigatorError as e:
    print(f"An error occurred: {e}")

Need speech-to-text for a video without captions, like an Instagram Reel? Call client.transcribe_video(video_url=...) in Python or await vn.transcribe(url) in JavaScript. It works on videos of any length.

With SDK 2.4.0 or later, client.watch_video(video_url=...) in Python or await vn.watch(url) in JavaScript returns what the video shows, scene by scene, next to what it says: see Watching Videos.

Next Steps

You've successfully made your first API call! Here's where you can go next:

Explore the API Reference

Dive deep into all the available endpoints and their parameters.

Check out the User Guides

Follow our step-by-step guides for common use cases.

On this page