Skip to navigation
System ComponentsVision MicroservicesObject Detection and Tracking

API Reference

View as Markdown

This page provides API reference for the Real Time Video Intelligence CV (RTVI-CV) Microservice.

Base URL

The API is available at http://<host>:9000. All API endpoints are prefixed with /api/v1.

Endpoint catalog

MethodEndpointDescription
GET/api/v1/liveLiveness probe
GET/api/v1/readyReadiness probe
GET/api/v1/startupStartup probe
GET/api/v1/metricsPrometheus metrics. Optional headers: X-REFRESH-PERIOD, X-OTLP-URL
GET/api/v1/stream/get-stream-infoList configured streams
POST/api/v1/stream/addAdd a stream
POST/api/v1/generate_text_embeddingsGenerate vector embeddings from text. Registered only when [text-embedder] enable=1

Stock warehouse object-detection configs leave [text-embedder] enable=0, so POST /api/v1/generate_text_embeddings is not registered and returns an endpoint-not-found response until you enable the module. Search-profile configs enable it by default. Refer to Text embedder (config) for the enable flag, model paths, and request examples.

Request and response examples for stream management and embeddings are on Object Detection and Tracking.