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.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
TranscriptResponse
TranscriptResponse
The response object from
get_transcript
. Contains video_info
and transcript
data.data.video_info
: AVideoInfo
object with metadata about the video.data.transcript
: A list ofTranscriptSegment
objects.
AnalysisResponse
AnalysisResponse
The response object from
analyze_video
.data.video_info
: AVideoInfo
object.data.transcript
: A list ofTranscriptSegment
objects.data.transcript_analysis
: AnAnalysisResult
object.
VideoSearchResponse
VideoSearchResponse
The response object from
search_videos
.data.results
: A list ofVideoSearchResult
objects.
Files Data Models
FilesListResponse
FilesListResponse
The response from
get_files
, containing a list of FileInfo
objects.FileResponse
FileResponse
The response from
get_file
, containing a FileInfo
object and an optional transcript
.FileSearchResponse
FileSearchResponse
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 baseVidNavigatorError
.
VidNavigatorError
VidNavigatorError
AuthenticationError
AuthenticationError
Raised when the API key is missing or invalid.
BadRequestError
BadRequestError
Raised for
400 Bad Request
errors, typically due to invalid parameters.AccessDeniedError
AccessDeniedError
Raised for
403 Forbidden
errors, indicating insufficient permissions.NotFoundError
NotFoundError
Raised for
404 Not Found
errors when a resource does not exist.RateLimitExceeded
RateLimitExceeded
Raised for
429 Too Many Requests
errors when you have exceeded your rate limit.PaymentRequiredError
PaymentRequiredError
Raised for
402 Payment Required
errors when you have exceeded your usage quota.ServerError
ServerError
Raised for
5xx
server-side errors.