API Documentation#

Following APIs are supported by VSS.

REST APIs for File Management

../_images/filesAPI.png

REST API for Live-Stream Management

../_images/livestream.png

REST API for Summarization & Q&A

../_images/summarizeapi.jpg

REST API for Alerts

../_images/alertapi.jpg

REST API for Models

../_images/modelsGET.png

REST API for Health Check

../_images/healthcheck.png

Detailed VSS API documentation is available at VSS ENDPOINT APIs Glossary. It is also available at http://<VSS_API_ENDPOINT>/docs after VSS is deployed.

Please refer to Launch UI for Helm or Launch UI for Docker Compose for instructions to find the VSS_API_ENDPOINT port information.

The --print-curl-command option of the Python CLI Client can also be used as a reference of the API request format.