# Nomadic

## Docs

- [API Authentication](https://docs.nomadicml.com/advanced/authentication.md): How to authenticate with the Nomadic API
- [Best Practices](https://docs.nomadicml.com/advanced/best-practices.md): Optimize your usage of Nomadic and get the most from your video analysis
- [Get analysis document](https://docs.nomadicml.com/api-reference/analysis/get-analysis-document.md): Return a specific analysis document for a video.
- [Get analysis status](https://docs.nomadicml.com/api-reference/analysis/get-analysis-status.md): Return status for a specific analysis document.
- [Read analysis events](https://docs.nomadicml.com/api-reference/analysis/read-analysis-events.md): Read server-sent progress events for a prompt-based analysis started with the analysis start endpoint.
- [Start analysis](https://docs.nomadicml.com/api-reference/analysis/start-analysis.md): Start a prompt-based analysis over one or more videos and return an event stream id for progress updates.
- [Stream analysis](https://docs.nomadicml.com/api-reference/analysis/stream-analysis.md): Start a prompt-based analysis and stream progress events in the same response. Prefer the start/events flow for resumable clients.
- [Verify API key](https://docs.nomadicml.com/api-reference/authentication/verify-api-key.md): Validate the caller's API key and return the associated user context.
- [Get batch analyses in bulk](https://docs.nomadicml.com/api-reference/batches/get-batch-analyses-in-bulk.md): Fetch analysis documents for many batch videos in one request.
- [Get batch status](https://docs.nomadicml.com/api-reference/batches/get-batch-status.md): Return batch progress, status, and associated video pointers.
- [Get import job](https://docs.nomadicml.com/api-reference/cloud-imports/get-import-job.md): Return metadata for a cloud import job.
- [Import GCS objects](https://docs.nomadicml.com/api-reference/cloud-imports/import-gcs-objects.md): Start asynchronous import for videos stored in Google Cloud Storage.
- [Import Hugging Face bucket objects](https://docs.nomadicml.com/api-reference/cloud-imports/import-hugging-face-bucket-objects.md): Start asynchronous import for videos stored in a Hugging Face bucket.
- [Import S3 objects](https://docs.nomadicml.com/api-reference/cloud-imports/import-s3-objects.md): Start asynchronous import for videos stored in S3 or S3-compatible storage.
- [List import job videos](https://docs.nomadicml.com/api-reference/cloud-imports/list-import-job-videos.md): Return paginated per-video status rows for a cloud import job.
- [Create GCS integration](https://docs.nomadicml.com/api-reference/cloud-integrations/create-gcs-integration.md): Create a reusable Google Cloud Storage integration.
- [Create Hugging Face bucket integration](https://docs.nomadicml.com/api-reference/cloud-integrations/create-hugging-face-bucket-integration.md): Create a reusable Hugging Face bucket integration.
- [Create S3 integration](https://docs.nomadicml.com/api-reference/cloud-integrations/create-s3-integration.md): Create a reusable S3 or S3-compatible storage integration.
- [Create S3 Storage Transfer integration](https://docs.nomadicml.com/api-reference/cloud-integrations/create-s3-storage-transfer-integration.md): Create an AWS IAM role integration for MCAP cloud ingest.
- [Delete cloud integration](https://docs.nomadicml.com/api-reference/cloud-integrations/delete-cloud-integration.md): Delete a saved cloud integration owned by the caller.
- [Get cloud integration](https://docs.nomadicml.com/api-reference/cloud-integrations/get-cloud-integration.md): Return metadata for a saved cloud integration.
- [Get role-based S3 import setup](https://docs.nomadicml.com/api-reference/cloud-integrations/get-role-based-s3-import-setup.md): Return the provider identity and setup details required for role-based S3 import.
- [Get role-based S3 import setup](https://docs.nomadicml.com/api-reference/cloud-integrations/get-s3-storage-transfer-setup.md): Return the provider identity and setup details required for role-based S3 import.
- [List cloud integrations](https://docs.nomadicml.com/api-reference/cloud-integrations/list-cloud-integrations.md): List saved cloud storage integrations visible to the caller.
- [Create folder](https://docs.nomadicml.com/api-reference/folders/create-folder.md): Create a personal or organization folder.
- [Create or get folder](https://docs.nomadicml.com/api-reference/folders/create-or-get-folder.md): Return an existing folder with the same name/scope or create it if missing.
- [Get folder by name](https://docs.nomadicml.com/api-reference/folders/get-folder-by-name.md): Return folder metadata by name and scope.
- [Attach stream](https://docs.nomadicml.com/api-reference/livestreams/attach-stream.md): Record stream metadata and notify Nomadic that a stream was attached.
- [Create signed live manifest URL](https://docs.nomadicml.com/api-reference/livestreams/create-signed-live-manifest-url.md): Create a short-lived signed URL for a live session HLS manifest.
- [End live session](https://docs.nomadicml.com/api-reference/livestreams/end-live-session.md): End an active live-stream analysis session.
- [Get live session](https://docs.nomadicml.com/api-reference/livestreams/get-live-session.md): Return details for a single live session.
- [List live sessions](https://docs.nomadicml.com/api-reference/livestreams/list-live-sessions.md): List live sessions visible to the caller.
- [Start live session](https://docs.nomadicml.com/api-reference/livestreams/start-live-session.md): Start a live-stream ingestion and optional rapid-review analysis session.
- [Create MCAP ingest](https://docs.nomadicml.com/api-reference/mcap/create-mcap-ingest.md): Create a signed upload target for a local MCAP source file.
- [Get MCAP import job](https://docs.nomadicml.com/api-reference/mcap/get-mcap-import-job.md): Return status for an MCAP cloud import job.
- [Get MCAP ingest](https://docs.nomadicml.com/api-reference/mcap/get-mcap-ingest.md): Return status and derived video metadata for an MCAP ingest.
- [Process MCAP ingest](https://docs.nomadicml.com/api-reference/mcap/process-mcap-ingest.md): Start processing an uploaded MCAP file into derived videos.
- [Start S3 MCAP cloud ingest](https://docs.nomadicml.com/api-reference/mcap/start-s3-mcap-cloud-ingest.md): Start MCAP ingest from an existing S3 integration.
- [Stitch MCAP views](https://docs.nomadicml.com/api-reference/mcap/stitch-mcap-views.md): Apply explicit front-channel and role metadata to an MCAP ingest.
- [Stitch uploaded views](https://docs.nomadicml.com/api-reference/multi-view/stitch-uploaded-views.md): Link already-uploaded videos into a multi-view group.
- [Upload a video](https://docs.nomadicml.com/api-reference/uploads/upload-a-video.md): Upload a local video file or register a remote video URL for asynchronous processing.
- [Create signed URLs in bulk](https://docs.nomadicml.com/api-reference/videos/create-signed-urls-in-bulk.md): Create short-lived signed playback URLs for multiple videos.
- [Create signed video URL](https://docs.nomadicml.com/api-reference/videos/create-signed-video-url.md): Create a short-lived signed playback URL for a video.
- [Delete video](https://docs.nomadicml.com/api-reference/videos/delete-video.md): Delete a video owned by or accessible to the caller.
- [Get video status](https://docs.nomadicml.com/api-reference/videos/get-video-status.md): Return upload and processing status for a video.
- [List videos](https://docs.nomadicml.com/api-reference/videos/list-videos.md): List videos visible to the caller, optionally scoped to a folder.
- [Quickstart](https://docs.nomadicml.com/getting-started/quickstart.md): This guide will help you get up and running with Nomadic quickly, either through our web platform or using the SDK.
- [Self-Hosted VPC Setup](https://docs.nomadicml.com/getting-started/vpc-setup.md): Deploy Nomadic in your own AWS or GCP virtual private cloud.
- [Nomadic AI Main Services Agreement](https://docs.nomadicml.com/more/main-services-agreement.md)
- [Privacy Policy](https://docs.nomadicml.com/more/privacy-policy.md)
- [Overview](https://docs.nomadicml.com/overview.md)
- [Analyzing Videos](https://docs.nomadicml.com/sdk/analyzing-videos/overview.md): Overview of prompt-based analyze()
- [Prompt Analysis](https://docs.nomadicml.com/sdk/analyzing-videos/prompt-analysis.md): Detect custom events using natural language prompts
- [add_batch_metadata()](https://docs.nomadicml.com/sdk/batch-results-metadata/add-batch-metadata.md): Add or update custom metadata for a batch analysis
- [get_batch_analysis()](https://docs.nomadicml.com/sdk/batch-results-metadata/get-batch-analysis.md): Retrieve analysis results for a completed batch
- [Cloud Storage Uploads](https://docs.nomadicml.com/sdk/cloud-storage.md): Securely upload videos from AWS, GCP, or Azure using direct cloud integration or signed URLs.
- [Livestreams](https://docs.nomadicml.com/sdk/livestreams.md): Start livestream analysis sessions, listen for events, and inspect stream timing fields.
- [LeRobot / GR00T Export](https://docs.nomadicml.com/sdk/robotics-lerobot-export.md): Turn Raw Robot Footage into a Subtask-Annotated, Training-Ready `LeRobot` Dataset for GR00T Finetuning.
- [SDK Usage Examples](https://docs.nomadicml.com/sdk/sdk-examples.md): Practical examples of using the Nomadic Python SDK for common tasks.
- [SDK Installation](https://docs.nomadicml.com/sdk/sdk_installation.md): Install and configure the Nomadic SDK
- [Search](https://docs.nomadicml.com/sdk/search.md): Semantic search across analysed events in a folder
- [Structured Exports](https://docs.nomadicml.com/sdk/structured-exports.md): ASAM OpenODD-compliant CSV exports
- [Cloud Imports (GCS / S3 / Cloudflare R2 / Hugging Face Buckets)](https://docs.nomadicml.com/sdk/uploading-videos/cloud-imports.md): Import videos directly from cloud storage
- [Local File & URL Uploads](https://docs.nomadicml.com/sdk/uploading-videos/local-files-urls.md): Upload local files, URLs, MCAPs, and multi-view sets
- [Uploading Videos](https://docs.nomadicml.com/sdk/uploading-videos/overview.md): Overview of the upload() method and supported sources
- [delete_video()](https://docs.nomadicml.com/sdk/video-folder-management/delete-video.md): Remove a video by ID
- [Folders](https://docs.nomadicml.com/sdk/video-folder-management/folders.md): Create and look up folders
- [my_videos()](https://docs.nomadicml.com/sdk/video-folder-management/my-videos.md): Retrieve uploaded videos, optionally filtered by folder

## OpenAPI Specs

- [openapi](https://docs.nomadicml.com/openapi.json)