> This page is for version 3.3.0 (default).
> For other versions, use one of these documentation indexes:
> - 3.3.0 (default): https://docs.nvidia.com/vss/3.3.0/llms.txt
> - Dev: https://docs.nvidia.com/vss/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/vss/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/vss/_mcp/server.

# Video Analytics API Reference

> Request and response schemas for the Video Analytics API

This reference is generated from the Video Analytics API OpenAPI specification. It includes request parameters, response schemas, and examples for every endpoint.

For a self-hosted Docker Compose deployment that includes the Video Analytics
API, replace the generated server URL with `http://<HOST_IP>:8081` for direct
access or `http://<HOST_IP>:7777/video-analytics-api` through the VSS ingress.
These are the default host ports; use the configured
`VIDEO_ANALYTICS_API_HOST_PORT` or `HAPROXY_HOST_PORT` if either was overridden.
Append the documented endpoint path to the selected base URL.

Select an endpoint in the navigation to jump to its documentation on this page.