skills.rest
sayalinvidia
sayalinvidiaCOMMUNITY
Explore all skills by this author →
GitHub

vss-setup-video-analytics-api

Deploy the vss-video-analytics-api standalone service with Docker Compose.

Updated Apr 16, 2026
Search Tags:#kafka#docker-compose#elasticsearch#deployment-guide#vss#video-analytics-api#standalone-deploy
One-click install
npx skills add https://github.com/sayalinvidia/sayali-skills-test --skill vss-setup-video-analytics-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: vss-setup-video-analytics-api
Source: https://github.com/sayalinvidia/sayali-skills-test/tree/main/skills/vss-setup-video-analytics-api
Command: npx skills add https://github.com/sayalinvidia/sayali-skills-test --skill vss-setup-video-analytics-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Deploys the standalone vss-video-analytics-api service to run the REST API without the full warehouse deployment, enabling a lighter, configurable setup.

Core Features & Use Cases

  • Standalone deployment: run only the video analytics API service with its own config, data-log bind, and connectivity to Elasticsearch and an optional Kafka.
  • Config-source flexibility: choose between the image-baked default, the service-shipped config, or supply a custom config.
  • Operational workflow: bind necessary volumes, verify health with the /livez endpoint, and integrate into existing Elasticsearch/Kafka deployments.

Quick Start

Run the standalone deployment using the provided docker-compose file for the analytics API service in deploy/docker/services/analytics/video-analytics-api/compose.yml.

Frequently Asked Questions about vss-setup-video-analytics-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a standalone video analytics REST API using Docker Compose?▼

To deploy a standalone video analytics REST API, use the provided Docker Compose file to run the service against an existing Elasticsearch cluster. This bypasses the full VSS warehouse deployment, enabling a lighter, configurable setup with optional Kafka connectivity.

What configuration options are available for deploying the video analytics API?▼

The video analytics API deployment supports three configuration sources: the image-baked default, the service-shipped default config, or a custom configuration file. You can also mount data-log volumes to manage operational data.

Do I need Elasticsearch and Kafka to run the video analytics API service?▼

You need an existing Elasticsearch cluster for the video analytics API service to connect and function. Kafka is optional and only required if you want to enable dynamic features within the pipeline.

How can I verify the video analytics API is healthy after standalone deployment?▼

You can verify the health of the standalone video analytics API by checking the /livez endpoint. This confirms the service is running correctly and connected to your Elasticsearch cluster.

Why use a standalone video analytics API deployment instead of the full VSS warehouse?▼

Use the standalone video analytics API deployment to run only the REST API service without the full VSS warehouse. This provides a lighter environment when you already have existing Elasticsearch and Kafka deployments.

Related Skills

Explore More Software Engineering Skills→
rblake2320rblake2320

vss-setup-video-analytics-api

Deploy the vss-video-analytics-api service standalone with Docker Compose.

Community
Intermediate
ajmeyers42ajmeyers42
1

weave-pipe

Generate Elasticsearch ingest pipeline JSON from field mapping specifications.

Community
Advanced
NaveedTechLabNaveedTechLab
11

event-streaming

Implement Kafka-based event streaming systems with producers and consumers.

Community
Advanced
rblake2320rblake2320

vss-setup-behavior-analytics

Deploy the vss-behavior-analytics service with Docker Compose for spatial-AI video analytics.

Community
Advanced