All available video operations via the SDK with complete parameter reference
This page describes all SDK methods for video operations. For in-depth code walkthroughs, see SDK Usage Examples.
Upload one or many local files or URLs.
Parameter | Type | Default | Description |
---|---|---|---|
videos | str | Path | Sequence[str | Path] | None | Single file/URL or list of files/URLs (required) |
edge_case_category | str | None | Routes to edge case upload pipeline |
folder | str | None | Folder name for organizing uploads |
upload_timeout | int | 1200 | Timeout in seconds for upload completion |
wait_for_uploaded | bool | True | Wait until upload is complete |
Returns: Dict (single) or List[Dict] (multiple) with video_id
and status
Run analysis on one or more uploaded videos with different analysis types.
Parameter | Type | Default | Description |
---|---|---|---|
ids | str | Sequence[str] | None | Video ID(s) to analyze |
analysis_type | AnalysisType | None | Type of analysis to perform |
model_id | str | "Nomadic-VL-XLarge" | AI model to use |
timeout | int | 2400 | Analysis timeout in seconds |
wait_for_completion | bool | True | Wait for analysis to complete |
folder | str | None | Analyze all videos in folder (mutually exclusive with ids ) |
Returns: Dict (single) or List[Dict] (multiple) with analysis results
For RAPID_REVIEW with is_thumbnail=True
, each event in the response will include an annotated_thumbnail_url
field containing a link to the generated thumbnail with bounding box annotations.
AnalysisType | What it does | Required extra parameters | Optional extra parameters |
---|---|---|---|
AnalysisType.RAPID_REVIEW | Rapid Review: “find-this-event” detection | custom_event: str custom_category: CustomCategory | str | is_thumbnail: bool = False |
AnalysisType.EDGE_CASE | Specialized edge-case detection | edge_case_category: str | concept_ids: List[str] mode: str = "assistant" |
AnalysisType.SEARCH | Semantic search within long videos | search_query: str |
nomadicml.video.CustomCategory
CustomCategory.DRIVING
CustomCategory.ROBOTICS
CustomCategory.AERIAL
CustomCategory.SECURITY
CustomCategory.ENVIRONMENT
Retrieve your uploaded videos, optionally filtered by folder.
Parameters:
Parameter | Type | Default | Description |
---|---|---|---|
folder_id | str | None | Filter videos by folder name |
Returns: List[Dict] with video information (video_id, filename, duration, size, etc.)
Remove a video by ID.
Parameters:
Parameter | Type | Default | Description |
---|---|---|---|
video_id | str | None | ID of the video to delete (required) |
Returns: Dict with deletion status
Search across videos in a folder using natural language queries.
Parameters:
Parameter | Type | Default | Description |
---|---|---|---|
query | str | None | Natural language search query (required) |
folder | str | None | Folder name to search within (required) |
reasoning_trace_path | str | None | Path for reasoning trace |
Returns: Dict with matches
and summary
fields
Retrieve thumbnail URLs for all events in an analysis. If thumbnails don’t exist, they will be generated automatically.
Parameters:
Parameter | Type | Default | Description |
---|---|---|---|
video_id | str | None | ID of the video (required) |
analysis_id | str | None | ID of the analysis containing events (required) |
Returns: List[str] of thumbnail URLs with bounding box annotations
Retrieve a single thumbnail URL for a specific event in an analysis.
Parameters:
Parameter | Type | Default | Description |
---|---|---|---|
video_id | str | None | ID of the video (required) |
analysis_id | str | None | ID of the analysis containing events (required) |
event_idx | int | None | 0-based index of the event (required) |
Returns: str - Single thumbnail URL
Raises: ValueError if event index is out of range
For a step-by-step tutorial, head over to SDK Usage Examples.