Skip to main content

Installation

Install the SDK from PyPI using pip:

Initialization

Initialize the client with your API key. You can find your key in the Developer Dashboard.
You can also use a context manager to ensure the client is closed after use:

Online Videos

Get Video Transcript

Transcribe a Video

Analyze a Video

Search for Videos


Files

Upload a File

List Files

Get File Info

Get Temporary File URL to view it in the browser

Retry File Processing

Cancel File Processing

Delete a File

Analyze an Uploaded File

Search Uploaded Files


System

Get API Usage

Health Check


Data Models

The SDK uses Pydantic models to represent the data returned by the API.

Online Videos Data Models

The response object from get_transcript. Contains video_info and transcript data.
  • data.video_info: A VideoInfo object with metadata about the video.
  • data.transcript: A list of TranscriptSegment objects.
The response object from analyze_video.
  • data.video_info: A VideoInfo object.
  • data.transcript: A list of TranscriptSegment objects.
  • data.transcript_analysis: An AnalysisResult object.
The response object from search_videos.
  • data.results: A list of VideoSearchResult objects.

Files Data Models

The response from get_files, containing a list of FileInfo objects.
The response from get_file, containing a FileInfo object and an optional transcript.
The response from search_files, with a list of FileSearchResult objects.

Exceptions

The Python SDK raises specific exceptions for different types of errors. All exceptions inherit from the base VidNavigatorError.
The base exception for all SDK-related errors.
Raised when the API key is missing or invalid.
Raised for 400 Bad Request errors, typically due to invalid parameters.
Raised for 403 Forbidden errors, indicating insufficient permissions.
Raised for 404 Not Found errors when a resource does not exist.
Raised for 429 Too Many Requests errors when you have exceeded your rate limit.
Raised for 402 Payment Required errors when you have exceeded your usage quota.
Raised for 5xx server-side errors.

More Information

For the complete source code and more examples, visit the PyPI package or the GitHub repository.