​
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"))
To get your API key, log in to the web platform, go to Profile > API Key, and generate a new key. We recommend storing your API key in an environment variable for security.

​
3. Upload and Analyze a Video

You can provide upload with a path to a local video file or a direct URL to a video hosted elsewhere. 
from nomadicml.video import AnalysisType
response = client.upload('https://storage.googleapis.com/videolm-bc319.firebasestorage.app/example-videos/Oakland-to-SF-on-Bridge.mp4')
result = client.analyze(
    response['video_id'],
    analysis_type=AnalysisType.RAPID_REVIEW,
    custom_event="Find all instances of ego vehicle straddling two lanes",
    custom_category="driving"
)
print(result)
For batch uploads, cloud URLs, or rerunning analysis see Video Operations.

​
Try it Yourself in Colab!

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

​
Next Steps

SDK Installation

Detailed SDK installation and configuration

Authentication

How to authenticate API requests

SDK Examples

Explore more examples of using the SDK