Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nomadicml.com/llms.txt

Use this file to discover all available pages before exploring further.

Detect custom events in videos using natural language prompts. The default analyzer uses Thinking mode, which matches the router behavior in the web app. Use Fast mode when you want speed-preferring analysis.
Prompt examples
# Single-video prompt, defaults to Thinking
analysis = client.analyze(
    "abc123",
    prompt="detect vehicles parked on the sidewalk",
)

# Fast mode
analysis = client.analyze(
    "abc123",
    prompt="detect delivery vans double parked",
    mode="fast",
)

# Request available telemetry directly in the prompt
analysis = client.analyze(
    "abc123",
    prompt="detect speeding events and include available speed, GPS, and timestamp evidence",
)

# Batch prompt: analyze multiple IDs at once
batch = client.analyze(
    ["abc123", "def456"],
    prompt="detect jaywalking near intersections",
)

# Batch prompt: analyze every video in a folder
batch = client.analyze(
    folder="fleet_uploads",
    prompt="detect jaywalking near intersections",
)

# Open an SDK-native video/event viewer
client.visualize(analysis)

# Open a viewer from a batch result or an existing batch ID
client.visualize(batch)
client.visualize(batch["batch_metadata"]["batch_id"])
Required Parameters:
ParameterTypeDescription
id(s) or folderstr | Sequence[str]Video ID(s) or folder name (use one, not both)
promptstrEvent description or question to analyze (e.g., “detect green crosswalks”)
Optional Parameters:
ParameterTypeDefaultDescription
modestr"thinking"Either "thinking" or "fast"
timeoutint2400Analysis timeout in seconds
waitboolTrueWait for analysis to complete
Returns: Dict with video_id, analysis_id, mode, status, summary, and events. Batch prompt analysis returns batch_metadata with batch_id, batch_viewer_url, and mode, plus a results list of normalized per-video results. Use client.visualize(batch) when you already have the SDK batch result. Use client.visualize(batch_id) to hydrate and render a saved batch later.
Prompt analysis does not expose router overrides, model selection, thumbnail flags, overlay flags, reasoning traces, or Wizarding Trace artifacts. Put analysis requirements directly in the prompt.