​

Quickstart Guide

This guide will help you get up and running with NomadicML quickly, either through our web platform or using the SDK.

​

Using the Web Platform

The fastest way to start using NomadicML is through our web platform at app.nomadicml.com.

​

1. Create an Account

Sign up for a free account on app.nomadicml.com.

​

2. Upload a Video

Once logged in, you can upload your first video for analysis:

1. Navigate to the dashboard
2. Click the “Upload” button
3. Select a video file from your computer.
4. Wait for the upload to complete

​

3. View Analysis Results

After uploading, NomadicML will automatically analyze your video:

1. The system will detect driving events, identify potential violations, and generate insights
2. Once processing is complete, you’ll see a list of detected events
3. Click on any event to view details, including AI analysis and recommendations

​

Using the SDK

For programmatic access to NomadicML, you can use our Python SDK.

​

1. Install the SDK

pip install nomadicml

​

2. Initialize the Client

from nomadicml import NomadicML
import os

# Initialize with your API key
client = NomadicML(api_key=os.environ.get("NOMADICML_API_KEY"))

​

3. Upload and Analyze a Video

The upload_and_analyze method is the most direct way to get started. You can provide it with a path to a local video file, a direct URL to a video hosted elsewhere, or even an existing video_id.

# Upload and analyze in one step using a named argument
result = client.video.upload_and_analyze(file_path="path/to/video.mp4")

# You can also re-run analysis on a previously uploaded video
# result = client.video.upload_and_analyze(video_id="abc123")

print(result)

For batch uploads, cloud URLs, or rerunning analysis see Video Upload & Analysis.

​

Try it Yourself in Colab!

This notebook walks you through the core functionalities of our SDK, including uploading a video and performing analysis.

​

Next Steps