# Lumeo Documentation Hub Documentation

> Lumeo is a no-code video analytics platform that lets developers, integrators and solution providers build custom video analytics and vision-AI based solutions in minutes, using drag-and-drop tools, ready-to-use AI models and analytic building blocks. Here you'll find comprehensive guides and documentation to help you start working with Lumeo as quickly as possible, as well as support if you get stuck. Let's jump right in!

## Guides
- [Overview](https://docs.lumeo.com/docs/overview.md): Lumeo is a no-code video analytics platform that enables you to rapidly design, deploy, and monitor custom video analytics and other vision-AI enabled applications.  This document provides you with an overview of Lumeo, the major building blocks you will use to build or deploy a vision-enabled solution, and where to find things.
- [Gateway](https://docs.lumeo.com/docs/gateway.md): A Gateway is a compute device that can process video from Streams, IP Cameras on the same network, or attached USB cameras.
- [Lumeo-Ready Gateways](https://docs.lumeo.com/docs/lumeo-ready-gateways.md): Lumeo-Ready Gateways are devices that ship with Lumeo pre-installed and a web based interface for easy configuration & setup in the field.
- [Gateway Hardware](https://docs.lumeo.com/docs/recommended-gateway-hardware.md): If you are looking to procure specific hardware for your Lumeo Gateways, here is some information on various vendors and how to acquire.
- [Lumeo Cloud Gateways](https://docs.lumeo.com/docs/lumeo-cloud-gateways.md): This document outlines how to setup Lumeo Cloud Gateways and associated limitations.
- [Lumeo Gateway Installer](https://docs.lumeo.com/docs/lumeo-gateway-installer.md): Use the Lumeo gateway installer script to install a Lumeo gateway on a bare-metal machine on-premises or a cloud GPU instance
- [AWS - EC2 Instance](https://docs.lumeo.com/docs/aws-ec2-instance.md): This guide shows you how to setup Lumeo Gateways to run in a AWS EC2 instance.
- [AWS - ECS](https://docs.lumeo.com/docs/aws-elastic-container-service.md): Run Lumeo Gateways in AWS Elastic Container Service
- [GCP - Kubernetes](https://docs.lumeo.com/docs/gcp-kubernetes-guide.md): This guide shows you how to setup Lumeo Gateways to run in a GCP Kubernetes Cluster.
- [GCP - Compute Instance](https://docs.lumeo.com/docs/gcp-compute-instance.md): This guide shows you how to setup Lumeo Gateways to run in a GCP compute engine instance.
- [Jetson Tips: Upgrading Jetson Devices](https://docs.lumeo.com/docs/jetson-tips-upgrading-jetsons.md)
- [Device-specific Documentation](https://docs.lumeo.com/docs/device-specific-documentation.md)
- [Camera & Streams](https://docs.lumeo.com/docs/camera.md): A Camera is an IP (Security) Camera, or a USB / CSI Camera attached to Gateway.
- [Genetec Security Center Import](https://docs.lumeo.com/docs/genetec-security-center-setup.md): This guide is for integrators and users who are setting up Genetec Security Center as a source for video with your Lumeo account.
- [Hanwha Wave Import](https://docs.lumeo.com/docs/hanwha-wave-setup.md): This guide is for integrators and users who are setting up Hanwha Wave as a source for video with your Lumeo account.
- [Milestone Import](https://docs.lumeo.com/docs/milestone-setup.md): This guide is for integrators and users who are setting up Milestone as a source for video with your Lumeo account.
- [PNM-C32084RQZ Setup](https://docs.lumeo.com/docs/pnm-c32084rqz-setup-guide.md): This guide is for integrators and users who are setting up a Hanwha PNM-C32084RQZ camera to work with your Lumeo account.
- [Ring Cameras](https://docs.lumeo.com/docs/ring.md): Process motion events and recordings from Ring cameras
- [Rhombus Camera Import](https://docs.lumeo.com/docs/rhombus-camera-import.md): This guide is for integrators and users who are setting up Rhombus Cameras as a source for video with your Lumeo account.
- [HikCentral Import](https://docs.lumeo.com/docs/hikcentral-setup.md): This guide is for integrators and users who are setting up HikCentral as a source for video with your Lumeo account.
- [Port Forwarding](https://docs.lumeo.com/docs/rtsp-port-forwarding.md)
- [Enable ONVIF on Camera](https://docs.lumeo.com/docs/enable-onvif-on-camera.md)
- [Virtual Cameras](https://docs.lumeo.com/docs/universal-bridge.md): Lumeo Virtual Cameras let you deploy analytics to video clips uploaded from cameras using SMTP, FTP, or via API
- [Clip & File Processing](https://docs.lumeo.com/docs/clip-and-file-processing.md): This section outlines how to process recorded video clips and files with Lumeo
- [Output Streams](https://docs.lumeo.com/docs/stream.md): This section outlines the output streams generated by Lumeo and how to view & share them with other applications.
- [Shared Streams](https://docs.lumeo.com/docs/shared-streams.md)
- [Workflow (aka Pipeline)](https://docs.lumeo.com/docs/pipeline.md): Workflows make it easy to process video, on the edge or in the cloud.  It is a flexible, cloud-managed, video processing engine that can route, process, store and transform video and images.
- [Deployments](https://docs.lumeo.com/docs/deployment.md): Deployments are how you run an analytic Workflow with a video source. This section outlines how to create, manage and use deployments.
- [Event](https://docs.lumeo.com/docs/event.md)
- [Dashboards](https://docs.lumeo.com/docs/dashboard.md): Lumeo Dashboards are flexible, multi-modal dashboards that make it easy to visualize video and analytics data for security, business and operational insights.
- [Advanced Data Access](https://docs.lumeo.com/docs/advanced-data-access.md): Advanced Data Access is a collection of capabilities that makes it possible to access Lumeo Dashboard data using SQL.
- [Search](https://docs.lumeo.com/docs/search.md): Lumeo's AI Search enables natural language and similar-appearance queries for media recordings saved to Lumeo Cloud
- [Notifications](https://docs.lumeo.com/docs/notifications.md): Setup and configure Lumeo notifications
- [Mobile App](https://docs.lumeo.com/docs/mobile-app.md): Access live streams, recordings, dashboards and notifications on the go with Lumeo mobile apps.
- [Account Management](https://docs.lumeo.com/docs/account.md): This guide outlines how to manage Lumeo accounts and workspaces.
- [Workspaces](https://docs.lumeo.com/docs/workspaces.md): This guide explains Workspaces and how to manage them.
- [Role Based Access Control](https://docs.lumeo.com/docs/roles.md): RBAC allows you to set permissions for individual users on your account to limit what they can do.
- [Single Sign On (SSO)](https://docs.lumeo.com/docs/single-sign-on-sso.md): This guide provides step-by-step instructions for setting up SAML2 SSO authentication for Lumeo, which is available on Enterprise plans.
- [Plans & Billing](https://docs.lumeo.com/docs/plans.md)
- [Node Plan Categories](https://docs.lumeo.com/docs/node-plan-categories.md)
- [Security & Network](https://docs.lumeo.com/docs/security-network.md): This document describes the information that may be of importance for IT/Security Teams as it pertains to software running on-premise connected to the Lumeo cloud platform.
- [Lumeo WebRTC Tester](https://docs.lumeo.com/docs/lumeo-webrtc-tester.md): Run the Diagnostic test below from a client browser to determine if your network is blocking WebRTC playback.
- [FAQ](https://docs.lumeo.com/docs/faq.md): Answers to frequently asked questions
- [Deployment Quick Start](https://docs.lumeo.com/docs/deployment-quick-start.md): This guide serves as a reference for deployment teams to setup Lumeo, onboard Gateways and Cameras, deploy analytics and setup Dashboards & Search.
- [Quick Start for Hanwha Vision](https://docs.lumeo.com/docs/hanwha-vision-quick-start.md): This guide serves as a reference for deployment teams to setup Lumeo with Hanwha Vision products, onboard Gateways and Cameras, deploy analytics and setup Dashboards & Search.
- [Quick Deploy Guide](https://docs.lumeo.com/docs/quick-deploy-guide.md): Follow these steps to quickly deploy a pre-built analytic solution with Lumeo
- [Observability & Metrics](https://docs.lumeo.com/docs/metrics.md): Lumeo Metrics allows you to monitor and track resource utilization on gateways by exporting them via OpenTelemetry.
- [Developer Quick Start - Custom Workflows](https://docs.lumeo.com/docs/getting-started-guide.md): Follow these steps to design and deploy your first vision solution with Lumeo
- [Node Reference](https://docs.lumeo.com/docs/node-reference.md)
- [Save GIF](https://docs.lumeo.com/docs/save-gif-node-1.md): Saves a GIF when a specific condition is met.
- [AI Model](https://docs.lumeo.com/docs/ai-model-node.md): Run an AI Model inference on input frames, and add detected objects to metadata.
- [AI Model by Roboflow](https://docs.lumeo.com/docs/ai-model-by-roboflow-node.md): Run a Roboflow AI Model inference on input frames, and add detected objects or object classes to metadata.
- [Add Metadata](https://docs.lumeo.com/docs/add-metadata-node.md): Inject a file or sockets contents as metadata to each frame.
- [Aggregate Metadata](https://docs.lumeo.com/docs/aggregate-metadata-node.md): Aggregates Metadata that matches specified wildcard patterns and adds resulting value for subsequent nodes to use.
- [Axis Network IO Read](https://docs.lumeo.com/docs/axis-network-io-read-node.md): Read a virtual IO port on an Axis device (or one that otherwise supports VAPIX).
- [Axis Network IO Write](https://docs.lumeo.com/docs/axis-network-io-write-node.md): Control a virtual IO port on an Axis device (or one that otherwise supports VAPIX).
- [Blur and Redact](https://docs.lumeo.com/docs/blur-and-redact-node.md): Blurs and redacts any detected objects or regions in the video
- [Calibrate Camera](https://docs.lumeo.com/docs/calibrate-camera-node.md): Calibrate camera view to real world distances
- [Caption Generator](https://docs.lumeo.com/docs/caption-generator-node.md): Generates textual descriptions of objects in a ROI, or of a ROI in the frame.
- [Color Classifier](https://docs.lumeo.com/docs/color-classifier-node.md): Classifies the predominant color of objects in a ROI, or of a ROI in the frame.
- [Create Incident in 24x7 Software IMS](https://docs.lumeo.com/docs/create-incident-in-24x7-software-ims-node.md): Create an incident in 247software.com Incident Management System when a specific condition is met.
- [Create Search Index](https://docs.lumeo.com/docs/create-search-index-node.md): Indexes resulting video clips with object, event, text and scene metadata so they are searchable using Lumeo AI Search.
- [Crop and Warp](https://docs.lumeo.com/docs/crop-and-warp-node.md): Crop, warp and rotate video to correct perspective and zoom in.
- [Custom Function](https://docs.lumeo.com/docs/custom-function-node.md): Manually process or modify frames and metadata using python code
- [Custom Function Repo](https://docs.lumeo.com/docs/custom-function-repo-node.md): Manually process or modify frames and metadata using python code from a specific Git repository
- [Demultiplex Video](https://docs.lumeo.com/docs/demultiplex-video-node.md): Separate a multiplexed stream into its consituent streams
- [Detect Pose](https://docs.lumeo.com/docs/detect-pose-node.md): Detects Pose Type for Person objects and using Pose keypoints if available.
- [Display Stream Info](https://docs.lumeo.com/docs/display-stream-info-node.md): Display stream meta and info on the video stream
- [Display Watermark](https://docs.lumeo.com/docs/display-watermark-node.md): Display a watermark on the video stream
- [Encode Video](https://docs.lumeo.com/docs/encode-video-node.md): Encode raw video frames and output an endcoded stream
- [Face Recognition Edge](https://docs.lumeo.com/docs/face-recognition-edge-node.md): Recognize faces on device by looking up against LDAP or a JSON list of faces.
- [Filter Objects](https://docs.lumeo.com/docs/filter-objects-node.md): Filter objects based on their presence within or outside a Region of interest.
- [Filter Stream](https://docs.lumeo.com/docs/filter-stream-node.md): Filter frames based on condition or interval
- [Generic Classifier](https://docs.lumeo.com/docs/generic-classifier-node.md): Retrieves classifier results based on the similarity of text prompts and the images of objects in a ROI, or of a ROI image contents.
- [Generic Detector](https://docs.lumeo.com/docs/generic-detector-node.md): Detect objects based on the similarity of text prompts and the images of objects in the frame.
- [Hanwha Vision IO Box Trigger](https://docs.lumeo.com/docs/hanwha-vision-io-box-trigger-node.md): Trigger IO ports on a Hanwha Vision SPM-4210 device.
- [Heatmap](https://docs.lumeo.com/docs/heatmap-node.md): Overlays a color heatmap on the video showing how much objects of a given type have used each part of the frame (dwell time, occupancy, or visits) to understand space utilization
- [Jetson GPIO Pin Read](https://docs.lumeo.com/docs/jetson-gpio-pin-read-node.md): Reads a GPIO pin and inserts its state and delta as customizable metadata entries.
- [Jetson GPIO Pin Write](https://docs.lumeo.com/docs/jetson-gpio-pin-write-node.md): Writes a value of a trigger condition to a GPIO pin.
- [License Plate MMC Platerecognizer](https://docs.lumeo.com/docs/license-plate-mmc-platerecognizer-node.md): High accuracy license plate + make/model/color recognition using your own Platerecognizer Snapshot API key or on-prem instance. Operates on plates previously detected using the License Plate Detection model.
- [License Plate Parser Edge](https://docs.lumeo.com/docs/license-plate-parser-edge-node.md): Extracts and post-processes license plates recognized using the License Plate Recognition - Edge AI Model
- [Line Crossing Counter](https://docs.lumeo.com/docs/line-crossing-counter-node.md): Counts how many particular tracked objects crossed each line
- [Local Vision Language Model Lookup](https://docs.lumeo.com/docs/local-vision-language-model-lookup-node.md): Perform visual question answering on objects in an ROI, or on a ROI in the frame using local models.
- [Modify and Merge Objects](https://docs.lumeo.com/docs/modify-and-merge-objects-node.md): Merges and modifies objects, changes object bbox sizes & attributes, and allows rename and grouping of class names
- [Motion Detection](https://docs.lumeo.com/docs/motion-detection-node.md): Detects scene and camera motion in the video stream.
- [Multiplex Video](https://docs.lumeo.com/docs/multiplex-video-node.md): Interleave two or more streams into one multiplexed stream for optimized processing.
- [OCR](https://docs.lumeo.com/docs/ocr-node.md): Perform OCR on objects in an ROI, or on a ROI in the frame.
- [Object Flow Counter](https://docs.lumeo.com/docs/object-flow-counter-node.md): Provides a breakdown of object types that cross a line or a sequence of lines from the Line Crossing Counter.
- [Object Motion Detection](https://docs.lumeo.com/docs/object-motion-detection-node.md): Detects moving objects in the specified region of interest (ROI).
- [Occupancy Monitor](https://docs.lumeo.com/docs/occupancy-monitor-node.md): Extracts queue, dwell and occupancy information based in how long detected objects have been present in a specified region in the video
- [Pose Recognition](https://docs.lumeo.com/docs/pose-recognition-node.md): Parses Bodypose model output and augments metadata
- [Presence Monitor](https://docs.lumeo.com/docs/presence-monitor-node.md): Extracts occupancy information for objects present in a specified region of interest.
- [Profile Performance](https://docs.lumeo.com/docs/profile-performance-node.md): Collect CPU, GPU, Memory utilization and FPS statistics to profile machine performance, and add to metadata.
- [Proximity Detector](https://docs.lumeo.com/docs/proximity-detector-node.md): Detect and create groups of objects when they are close to or far from each other.
- [Publish and Receive MQTT Messages](https://docs.lumeo.com/docs/publish-and-receive-mqtt-messages-node.md): Send and receive metadata from the pipeline to a MQTT topic at a periodic interval or based on a trigger.
- [Publish to BigQuery](https://docs.lumeo.com/docs/publish-to-bigquery-node.md): Publish metrics to Google BigQuery for charting and visualization.
- [Publish to Elasticsearch](https://docs.lumeo.com/docs/publish-to-elasticsearch-node.md): Publish metadata to Elasticsearch for reporting and dashboards.
- [Publish to Google Sheets](https://docs.lumeo.com/docs/publish-to-google-sheets-node.md): Publishes selected metadata using Google Sheets API
- [Publish to Lumeo Dashboard](https://docs.lumeo.com/docs/publish-to-lumeo-dashboard-node.md): Publish metrics to Lumeo Dashboard for charting and visualization.
- [ReIdentify Objects](https://docs.lumeo.com/docs/reidentify-objects-node.md): Reidentify objects by comparing signatures generated by a ReId model. Overwrites object tracking ids when match found.
- [Receive HTTP Webhook](https://docs.lumeo.com/docs/receive-http-webhook-node.md): Inserts metadata from HTTP requests' JSON bodies or URL query parameters.
- [Recognize Barcodes](https://docs.lumeo.com/docs/recognize-barcodes-node.md): Recognize barcodes in video
- [Save Clip](https://docs.lumeo.com/docs/save-clip-node.md): Save a clip and associated metadata when a specific condition is met
- [Save GIF](https://docs.lumeo.com/docs/save-gif-node.md): Saves a GIF when a specific condition is met.
- [Save Snapshot](https://docs.lumeo.com/docs/save-snapshot-node.md): Save a snapshot and associated metadata when a specific condition is met
- [Scene Change Detection](https://docs.lumeo.com/docs/scene-change-detection-node.md): Performs scene change and obstruction detection in a specified region of the video for OSHA compliance and other use cases.
- [Send HTTP Webhook](https://docs.lumeo.com/docs/send-http-webhook-node.md): Send metadata, snapshots, clips from the pipeline to a HTTP endpoint / API at a periodic interval or based on a trigger.
- [Trigger Email alert](https://docs.lumeo.com/docs/trigger-email-alert-node.md): Send an e-mail or push notification when a trigger condition is met.
- [Smart Zoom](https://docs.lumeo.com/docs/smart-zoom-node.md): Pan and Zoom to cover specific objects detected by any AI model
- [Speed Estimation](https://docs.lumeo.com/docs/speed-estimation-node.md): Estimates speeds of objects in a ROI and sets triggers based on low/high thresholds.
- [Stream RTMP](https://docs.lumeo.com/docs/stream-rtmp-node.md): Create a RTMP output stream to send to YouTube, Mux, Wowza and more.
- [Stream RTSP](https://docs.lumeo.com/docs/stream-rtsp-node.md): Create an RTSP output stream for use in other pipelines or streams
- [Stream WebRTC](https://docs.lumeo.com/docs/stream-webrtc-node.md): Create a WebRTC output stream to view in a web browser
- [Stream to Homekit](https://docs.lumeo.com/docs/stream-to-homekit-node.md): Create a Homekit Camera accessory that can be discovered from and streams to Apple Homekit compatible devices.
- [Sync and Tile Frames](https://docs.lumeo.com/docs/sync-and-tile-frames-node.md): Synchronize metadata & create video tiles/grids between nodes across one or more deployments on the same Gateway.
- [Tailgating](https://docs.lumeo.com/docs/tailgating-node.md): Analyses line crossings to detect tailgating events.
- [Text to Speech](https://docs.lumeo.com/docs/text-to-speech-node.md): Generate speech audio from a prompt when a trigger or event occurs and save locally or play via SIP.
- [Tile Video in Grid](https://docs.lumeo.com/docs/tile-video-in-grid-node.md): Arrange the constituent streams of a multiplexed stream into a grid
- [Time Trigger](https://docs.lumeo.com/docs/time-trigger-node.md): Set a trigger based on current time
- [Track Attributes](https://docs.lumeo.com/docs/track-attributes-node.md): Tracks attributes of objects and persists them across frames.
- [Track Objects](https://docs.lumeo.com/docs/track-objects-node.md): Track detected objects and assign a unique identifier to each new object
- [Transform Pixels](https://docs.lumeo.com/docs/transform-pixels-node.md): Adjust brightness, contrast, sharpen, denoise of ROIs or objects in the video
- [Transform Video](https://docs.lumeo.com/docs/transform-video-node.md): Manipulate video transformations, resolution and frame rate
- [Trigger Genetec Alarm](https://docs.lumeo.com/docs/trigger-genetec-alarm-node.md): Trigger an alarm in Genetec Security Center when a specific condition is met
- [Trigger Google Chat Alert](https://docs.lumeo.com/docs/trigger-google-chat-alert-node.md): Send a Google Chat alert when a specific condition is met.
- [Trigger Hanwha Blaze Event](https://docs.lumeo.com/docs/trigger-hanwha-blaze-event-node.md): Trigger a Generic Event in Hanwha Blaze VMS
- [Trigger Hanwha Wave Event](https://docs.lumeo.com/docs/trigger-hanwha-wave-event-node.md): Trigger a Generic Event or Bookmark in Hanwha Wave VMS
- [Trigger HikCentral Alarm](https://docs.lumeo.com/docs/trigger-hikcentral-alarm-node.md): Trigger an alarm in HikCentral
- [Trigger ISS SecurOS Event](https://docs.lumeo.com/docs/trigger-iss-securos-event-node.md): Trigger a Analytics Event in ISS SecurOS VMS
- [Trigger Immix Alarm](https://docs.lumeo.com/docs/trigger-immix-alarm-node.md): Trigger an Alarm in Immix using the SMTP interface when a trigger condition is met.
- [Trigger Microsoft Teams alert](https://docs.lumeo.com/docs/trigger-microsoft-teams-alert-node.md): Send a Microsoft Teams message when a trigger condition is met.
- [Trigger Milestone Event](https://docs.lumeo.com/docs/trigger-milestone-event-node.md): Trigger an analytics event in XProtect
- [Trigger Notification](https://docs.lumeo.com/docs/trigger-notification-node.md): Send an e-mail or push notification when a trigger condition is met.
- [Trigger Pushover Notification](https://docs.lumeo.com/docs/trigger-pushover-notification-node.md): Send a push notification using Pushover app
- [Trigger Rhombus Event](https://docs.lumeo.com/docs/trigger-rhombus-event-node.md): Trigger an analytics event in Rhombus
- [Trigger SMS Alert](https://docs.lumeo.com/docs/trigger-sms-alert-node.md): Send an SMS alert when a specific condition is met.
- [Trigger Slack alert](https://docs.lumeo.com/docs/trigger-slack-alert-node.md): Send a Slack message when a trigger condition is met.
- [Trigger Solink Event](https://docs.lumeo.com/docs/trigger-solink-event-node.md): Trigger an Event in Solink
- [Trigger an Event](https://docs.lumeo.com/docs/trigger-an-event-node.md): Adds the specified event to the metadata stream for use by downstream nodes.
- [Video Source](https://docs.lumeo.com/docs/video-source-node.md): Use cameras, RTSP streams or files as input sources.
- [Vision Language Model Lookup](https://docs.lumeo.com/docs/vision-language-model-lookup-node.md): Perform a lookup with Vision Language Models (VLM) on objects in an ROI, or on a ROI in the frame. Supports models like GPT-4o, Claude, Gemini, Llama using Lumeo Cloud, Google, OpenAI, Anthropic, Nvidia, AWS Bedrock.
- [Trigger Conditions Guide](https://docs.lumeo.com/docs/trigger-conditions.md): Triggers help you act on specific events in a Lumeo pipeline. This guide walks you through understanding Triggers and creating them.
- [Bulk Clip Processing Guide](https://docs.lumeo.com/docs/clip-bulk-processing-guide.md): This guide walks you through using Lumeo to process a large number of files in a scalable manner.
- [AI Models](https://docs.lumeo.com/docs/ai-models.md): AI Models allow you to extract information from video such as detecting people, vehicles, identifying if a person is wearing a mask etc.
- [Camera AI Models](https://docs.lumeo.com/docs/camera-ai-models.md): Follow this guide to use a camera's built in AI models with Lumeo
- [Lumeo Model Reference](https://docs.lumeo.com/docs/model-labels.md): This page lists the labels for objects that Lumeo Marketplace Models detect or classify.
- [Model Conversion](https://docs.lumeo.com/docs/model-conversion.md): This guide outlines steps to convert models so that they can be imported and used in Lumeo.
- [Custom Model Parser](https://docs.lumeo.com/docs/custom-parsing-the-inference-model-output.md)
- [Azure Custom Vision Models](https://docs.lumeo.com/docs/azure-custom-vision-models.md): This guide walks you through how to train a model using Azure CustomVision.ai and use it with Lumeo.
- [API & Scripts](https://docs.lumeo.com/docs/api.md): The Lumeo API gives you an easy way to control your application and integrate cameras, video, storage, processing, streaming and model management with your application.
- [MCP](https://docs.lumeo.com/docs/mcp.md)
- [Use-case Guides](https://docs.lumeo.com/docs/use-case-guides.md): This section contains use-case specific guides.
- [License Plate Recognition Guide](https://docs.lumeo.com/docs/configuring-lpr-and-vehicle-makemodelcolor-analytics-for-various-use-cases.md): Optimizing license plate and vehicle recognition analytics for various operational use cases
- [OEM Setup](https://docs.lumeo.com/docs/oem-setup.md): This guide explains how OEMs should setup the device to be shipped out.

## API Reference
- [Read an Application](https://docs.lumeo.com/reference/get_application.md): Reads the `Application` by id.
- [Update Application](https://docs.lumeo.com/reference/update_application.md): Updates the Application.
- [Delete an Application](https://docs.lumeo.com/reference/delete_application.md): Deletes the application and all gateways associated with it.
- [gateways](https://docs.lumeo.com/reference/gateways.md)
- [List Gateways](https://docs.lumeo.com/reference/list_gateways.md): List all the gateways assigned to this application.
- [Read Gateway](https://docs.lumeo.com/reference/get_gateway.md): Reads a specific gateway.
- [Delete Gateway](https://docs.lumeo.com/reference/delete_gateway.md): Delete a gateway.
- [List Tags](https://docs.lumeo.com/reference/list_gateway_tags.md): List all IDs of tags a Gateway is tagged with.
- [Add Tags to Gateway](https://docs.lumeo.com/reference/create_gateway_tags.md): Add a list of all tag IDs that you want the Gateway to be tagged with. Returns a list of all tags (not just the added ones).
- [Remove Tags from Gateway](https://docs.lumeo.com/reference/remove_gateway_tags.md): Remove a list of tag IDs from the Gateway. Returns a list of all tags (after removal).
- [Create Camera Discovery Request](https://docs.lumeo.com/reference/create_discovery_request.md): Create a gateway's (cameras) discovery request.
- [Read Camera Discovery Request](https://docs.lumeo.com/reference/get_discovery_request.md): Reads a specific discovery request.
- [Delete Camera Discovery Request](https://docs.lumeo.com/reference/delete_discovery_request.md): Deletes a specific discovery request.
- [List Gateway Streams](https://docs.lumeo.com/reference/list_gateway_streams.md): List all streams associated with a specific gateway.
- [List Linked Cameras](https://docs.lumeo.com/reference/list_linked_cameras.md): Lists cameras linked to this gateway and available for use to any pipelines deployed on this gateway.
- [Restart Gateway](https://docs.lumeo.com/reference/restart_gateway.md): Restarts the gateway.
- [List Cameras](https://docs.lumeo.com/reference/list_cameras.md): Lists all the cameras added to this application. Cameras represent cameras available for use by the application's compute infrastructure.
- [Create Camera](https://docs.lumeo.com/reference/create_camera.md): Create a new camera that is available to pipelines running in the application.
- [Read Camera](https://docs.lumeo.com/reference/get_camera.md): Reads a specific camera.
- [Update Camera](https://docs.lumeo.com/reference/update_camera.md): Updates a specific camera.
- [Delete Camera](https://docs.lumeo.com/reference/delete_camera.md): Deletes a specific camera.
- [List Camera Streams](https://docs.lumeo.com/reference/list_camera_streams.md): List all streams available on a specific camera.
- [Take Camera Snapshot](https://docs.lumeo.com/reference/create_camera_snapshot.md): Takes camera snapshot. Returns File object to track uploading status.
- [List Tags](https://docs.lumeo.com/reference/list_camera_tags.md): List all IDs of tags a camera is tagged with.
- [Add Tags to Camera](https://docs.lumeo.com/reference/create_camera_tags.md): Add a list of all tag IDs that you want the camera to be tagged with. Returns a list of all tags (not just the added ones).
- [Remove Tags from Camera](https://docs.lumeo.com/reference/remove_camera_tags.md): Remove a list of tag IDs from the camera. Returns a list of all tags (after removal).
- [Add Reference Pipelines to Camera](https://docs.lumeo.com/reference/create_camera_reference_pipelines.md): Add a list of reference pipelines to the camera. Returns a list of all pipelines (not just the added ones).
- [Remove Reference Pipelines from Camera](https://docs.lumeo.com/reference/remove_camera_reference_pipelines.md): Remove a list of reference pipelines from the camera. Returns a list of all pipelines (after removal).
- [Add Reference Deployments to Camera](https://docs.lumeo.com/reference/create_camera_reference_deployments.md): Add a list of reference deployments to the camera. Returns a list of all deployments (not just the added ones).
- [Remove Reference Deployments from Camera](https://docs.lumeo.com/reference/remove_camera_reference_deployments.md): Remove a list of reference deployments from the camera. Returns a list of all deployments (after removal).
- [List Streams](https://docs.lumeo.com/reference/list_streams.md): List streams in a specific application.
- [Create Stream](https://docs.lumeo.com/reference/create_stream.md): Create a new stream that is available to pipelines running in the application.
- [Read Stream](https://docs.lumeo.com/reference/get_stream.md): Read a specific stream.
- [Update Stream](https://docs.lumeo.com/reference/update_stream.md): Update a specific stream.
- [Delete Stream](https://docs.lumeo.com/reference/delete_stream.md): Delete a specific stream.
- [Take Stream Snapshot](https://docs.lumeo.com/reference/create_stream_snapshot.md): Takes stream snapshot. Returns File object to track uploading status.
- [List Tags](https://docs.lumeo.com/reference/list_stream_tags.md): List all IDs of tags a stream is tagged with.
- [Add Tags to Stream](https://docs.lumeo.com/reference/create_stream_tags.md): Add a list of all tag IDs that you want the stream to be tagged with. Returns a list of all tags (not just the added ones).
- [Remove Tags from Stream](https://docs.lumeo.com/reference/remove_stream_tags.md): Remove a list of tag IDs from the stream. Returns a list of all tags (after removal).
- [List Pipelines](https://docs.lumeo.com/reference/list_pipelines.md): List the pipelines in this application
- [Create Pipeline](https://docs.lumeo.com/reference/create_pipeline.md): Creates a new Pipeline for use by gateways in the application.
- [Read Pipeline](https://docs.lumeo.com/reference/get_pipeline.md): Read a pipeline
- [Update Pipeline](https://docs.lumeo.com/reference/update_pipeline.md): Update a pipeline
- [Delete Pipeline](https://docs.lumeo.com/reference/delete_pipeline.md): Deletes a Pipeline
- [Create Pipeline Deployment](https://docs.lumeo.com/reference/create_deployment.md): Creates a new pipeline deployment on a specific gateway or makes a load balanced deployment if no gateway is specified.
- [List Pipeline Deployments](https://docs.lumeo.com/reference/list_deployments.md): List pipeline deployments in this application.
- [Read Pipeline Deployment](https://docs.lumeo.com/reference/get_deployment.md): Retrive a specific Pipeline Deployment
- [Update Pipeline Deployment](https://docs.lumeo.com/reference/update_deployment.md): Update a specific Pipeline Deployment
- [Delete Pipeline Deployment](https://docs.lumeo.com/reference/delete_deployment.md): Deletes a pipeline deployment from a gateway.
- [Start Deployment](https://docs.lumeo.com/reference/start_deployment.md): Starts the pipeline deployment.
- [Stop Deployment](https://docs.lumeo.com/reference/stop_deployment.md): Stops the pipeline deployment.
- [List Deployment Streams](https://docs.lumeo.com/reference/list_deployment_streams.md): List all streams that are part of a specific deployment.
- [List Tags](https://docs.lumeo.com/reference/list_deployment_tags.md): List all IDs of tags a deployment is tagged with.
- [Add Tags to Deployment](https://docs.lumeo.com/reference/create_deployment_tags.md): Add a list of all tag IDs that you want the deployment to be tagged with. Returns a list of all tags (not just the added ones).
- [Remove Tags from Deployment](https://docs.lumeo.com/reference/remove_deployment_tags.md): Remove a list of tag IDs from the deployment. Returns a list of all tags (after removal).
- [List Deployment Queues](https://docs.lumeo.com/reference/list_deployment_queues.md)
- [List Deployment Queue Entries](https://docs.lumeo.com/reference/list_deployment_queue_entries.md)
- [Create a Deployment Queue Entry](https://docs.lumeo.com/reference/create_deployment_queue_entry.md)
- [Read a Deployment Queue Entry](https://docs.lumeo.com/reference/read_deployment_queue_entry.md)
- [Delete a Deployment Queue Entry](https://docs.lumeo.com/reference/delete_deployment_queue_entry.md)
- [Get a list of events](https://docs.lumeo.com/reference/list_events.md): Get a list of events
- [List Files](https://docs.lumeo.com/reference/list_files.md): List files in this application.
- [Create File](https://docs.lumeo.com/reference/create_file.md): Create a new file object and receive a presigned URL that the content can be uploaded to.
- [Delete Multiple Files](https://docs.lumeo.com/reference/delete_multiple_files.md): Delete multiple files. At least one query parameter is required.
- [Read File](https://docs.lumeo.com/reference/get_file.md): Retrieve a File object.
- [Update File](https://docs.lumeo.com/reference/update_file.md): Update a file.
- [Delete File](https://docs.lumeo.com/reference/delete_file.md): Delete a file.
- [Read File Data](https://docs.lumeo.com/reference/get_file_data.md): Returns a presigned GET URL to the file's content. The URL is valid for 24 hours.
- [List Tags](https://docs.lumeo.com/reference/list_file_tags.md): List all IDs of tags a file is tagged with.
- [Add Tags to File](https://docs.lumeo.com/reference/create_file_tags.md): Add a list of all tag IDs that you want the file to be tagged with. Returns a list of all tags (not just the added ones).
- [Remove Tags from File](https://docs.lumeo.com/reference/remove_file_tags.md): Remove a list of tag IDs from the file. Returns a list of all tags (after removal).
- [List Models](https://docs.lumeo.com/reference/list_models.md): List all Machine learning Models in this `Application`
- [Create a Model](https://docs.lumeo.com/reference/create_model.md): Create a Model. The response object's `weights_file_url` (and `metadata_file_url` if a metadata filename was given) will be presigned so the corresponding files can be uploaded there with a simple PUT request. The URL is valid for 24 hours.
- [Read a Model](https://docs.lumeo.com/reference/get_model.md): Read a Machine learning Model
- [Update a Model](https://docs.lumeo.com/reference/update_model.md): Update this Machine learning Model.  The response object's `weights_file_url` (and `metadata_file_url` if a metadata filename was given) will be presigned so the corresponding files can be uploaded there with a simple PUT request. The URL is valid for 24 hours.
- [Delete Model](https://docs.lumeo.com/reference/delete_model.md): Deletes a model.
- [List Tags](https://docs.lumeo.com/reference/list_tags.md): List tags in a specific application.
- [Create Tag](https://docs.lumeo.com/reference/create_tag.md): Create a new tag that can be used to tag other entities.
- [Read Tag](https://docs.lumeo.com/reference/get_tag.md): Read a specific tag.
- [Update Tag](https://docs.lumeo.com/reference/update_tag.md): Update a specific tag.
- [Delete Tag](https://docs.lumeo.com/reference/delete_tag.md): Delete a specific tag.
- [List Shared Streams](https://docs.lumeo.com/reference/list_shared_streams.md): List shared streams in a specific application.
- [Create Shared Stream](https://docs.lumeo.com/reference/create_shared_stream.md): Create a new stream that is available to pipelines running in the application.
- [Read Shared Stream](https://docs.lumeo.com/reference/get_shared_stream.md): Read a specific shared stream.
- [Delete Shared Stream](https://docs.lumeo.com/reference/delete_shared_stream.md): Delete a specific shared stream.
- [Create Search JWT token](https://docs.lumeo.com/reference/search_jwt.md): Creates a JWT token to use with the Search endpoint "v1/apps/:application_id/search". The token is valid for 24 hours.
- [Search for deployment files](https://docs.lumeo.com/reference/search-2.md): Search for deployment files. To use this endpoint, you need to create a special JWT token with the `/v1/apps/:application_id/auth/search_jwt` endpoint.
- [Create Search JWT token (deprecated)](https://docs.lumeo.com/reference/deprecated_search_jwt.md)
- [List Trackable Lists](https://docs.lumeo.com/reference/list_trackable_lists.md): Lists all the trackable lists added to this application. Trackable lists represent collections of objects that can be tracked in video streams.
- [Create Trackable List](https://docs.lumeo.com/reference/create_trackable_list.md): Create a new trackable list that can be used to track objects in video streams within the application.
- [Delete Multiple Trackable Lists](https://docs.lumeo.com/reference/delete_multiple_trackable_lists.md): Deletes multiple trackable lists based on the provided filter criteria. At least one filter parameter must be provided.
- [Update Trackable List](https://docs.lumeo.com/reference/update_trackable_list.md): Updates a specific trackable list.
- [List Trackable Items](https://docs.lumeo.com/reference/list_trackable_items.md): Lists all the trackable items in a specific trackable list.
- [Create Trackable Item](https://docs.lumeo.com/reference/create_trackable_item.md): Create a new trackable item within a trackable list.
- [Delete Multiple Trackable Items](https://docs.lumeo.com/reference/delete_multiple_trackable_items.md): Deletes multiple trackable items based on the provided filter criteria. At least one filter parameter must be provided.
- [Update Trackable Item](https://docs.lumeo.com/reference/update_trackable_item.md): Updates a specific trackable item.
- [List Trackable Files](https://docs.lumeo.com/reference/list_trackable_files.md): Lists all the trackable files for a specific trackable item.
- [Create Trackable File](https://docs.lumeo.com/reference/create_trackable_file.md): Create a new trackable file for a trackable item.
- [Delete Multiple Trackable Files](https://docs.lumeo.com/reference/delete_multiple_trackable_files.md): Deletes multiple trackable files based on the provided filter criteria. At least one filter parameter must be provided.
- [Update Trackable File](https://docs.lumeo.com/reference/update_trackable_file.md): Updates a specific trackable file.
- [Update Trackable File Availability](https://docs.lumeo.com/reference/update_trackable_file_availability.md): Updates the availability status of a trackable file. This endpoint should be called after the file content has been uploaded to signal that the content blob is ready for processing.
- [List Trackable Items Across Lists](https://docs.lumeo.com/reference/list_trackable_items_cross_list.md): Lists trackable items across multiple trackable lists or all lists in the application. This endpoint allows filtering items by list IDs without requiring the list ID in the path. Items are automatically deduplicated if they appear in multiple lists.
- [Create Inference JWT token](https://docs.lumeo.com/reference/inference_jwt.md): Creates a JWT token to use with the Inference endpoint. The token is valid for 24 hours.
- [List Notification Categories](https://docs.lumeo.com/reference/list_notification_categories.md): Returns the list of notification category values understood by the server (e.g. `operational`, `platform_health`, `analytics`). Use these as values in `notification_categories` when creating or updating a notification rule.
- [List Notification Types](https://docs.lumeo.com/reference/list_notification_types.md): Returns every notification type the server can emit, paired with the categories it belongs to. Use the `value` field as a value in `notification_types` and the `categories` field to discover which category buckets a type contributes to.
- [List Notification Channel Preferences](https://docs.lumeo.com/reference/list_notification_channel_preferences.md): Returns the calling user's notification channel preferences for this application. Each entry describes whether a delivery channel (email, push, sms) is enabled and any channel-specific configuration.
- [Upsert Notification Channel Preference](https://docs.lumeo.com/reference/upsert_notification_channel_preference.md): Sets the calling user's preference for a single notification channel. Existing preferences for the same channel are replaced.
- [List Notification Rules](https://docs.lumeo.com/reference/list_notification_rules.md): Lists notification rules configured in this application. Each rule selects which notification types reach which user groups, with optional entity filters and (for analytics) title-keyword filters.
- [Create Notification Rule](https://docs.lumeo.com/reference/create_notification_rule.md): Creates a notification rule. Recipients are determined by `user_group_ids` (an empty list resolves to the default "all members" group). Optional `entity_filters` narrow delivery to specific gateways, cameras, streams, deployments, pipelines, or tags. Optional `title_keywords` further filter analytics events by case-insensitive substring match against the event title.
- [Delete Multiple Notification Rules](https://docs.lumeo.com/reference/delete_multiple_notification_rules.md): Deletes multiple notification rules by id. At least one `notification_rule_ids[]` value must be provided.
- [Update Notification Rule](https://docs.lumeo.com/reference/update_notification_rule.md): Partially updates a notification rule. Omitted fields are left unchanged. Use `entity_filters` set to `null` to clear it.
- [List User Groups](https://docs.lumeo.com/reference/list_user_groups.md): Lists user groups in this application. Each application has an auto-managed default group ("All members") with `is_default = true`, plus any explicitly created groups. Use group ids in `notification_rules.user_group_ids` to address recipients.
- [Create User Group](https://docs.lumeo.com/reference/create_user_group.md): Creates a non-default user group with the given name.
- [Delete Multiple User Groups](https://docs.lumeo.com/reference/delete_multiple_user_groups.md): Deletes multiple user groups by id. At least one `user_group_ids[]` value must be provided. Default groups (`is_default = true`) are silently skipped.
- [Update User Group](https://docs.lumeo.com/reference/update_user_group.md): Renames a user group. The default group (`is_default = true`) cannot be renamed.
- [List User Group Members](https://docs.lumeo.com/reference/list_user_group_members.md): Lists the members of a user group.
- [Add User Group Member](https://docs.lumeo.com/reference/add_user_group_member.md): Adds an account to the user group as a member.
- [Remove User Group Members](https://docs.lumeo.com/reference/remove_user_group_members.md): Removes one or more accounts from a user group. At least one `account_ids[]` value must be provided.

## Recipes
- [Bullk process files by queueing deployments](https://docs.lumeo.com/recipes/bullk-process-files-by-queueing-deployments.md)
- [Discover and Create new Cameras](https://docs.lumeo.com/recipes/discover-and-create-new-cameras.md)
- [Download Clip & Snapshots](https://docs.lumeo.com/recipes/download-clip-snapshots.md)
- [Process a HLS or RTSP Stream using a Pipeline](https://docs.lumeo.com/recipes/process-a-hls-or-rtsp-stream-using-a-pipeline.md)

## Changelog
- [Lumeo Gateway 3.2.19](https://docs.lumeo.com/changelog/lumeo-gateway-3219.md)
- [Lumeo Gateway 3.1.44](https://docs.lumeo.com/changelog/lumeo-gateway-3144.md)
- [Lumeo Platform - April 2026](https://docs.lumeo.com/changelog/lumeo-platform-april-2026.md)
- [Lumeo Web Gateway Manager v4.12](https://docs.lumeo.com/changelog/lumeo-web-gateway-manager-v412.md)
- [Lumeo Gateway 3.0.10](https://docs.lumeo.com/changelog/lumeo-gateway-3010.md)