VSS API Glossary#
This glossary provides detailed documentation for the VSS API endpoints.
Alerts API#
Alerts-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
List all live stream alerts added to the VIA Server. |
|
Add an alert for a live stream. |
|
Delete a live stream alert added to the VIA Server. |
|
Get recently generated alerts. Optionally filter by live stream ID. |
Chat API#
Chat-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Run video interactive question and answer. |
Files API#
Files-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Files are used to upload media files. |
|
Returns a list of files. |
|
The ID of the file to use for this request. |
|
Returns information about a specific file. |
|
Returns the contents of the specified file. |
Health API#
Health-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Get VIA readiness status. |
|
Get VIA liveness status. |
Live-stream API#
Live-stream-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
List all live streams. |
|
API for adding live / camera stream. |
|
API for removing live / camerea stream matching stream_id. |
Metrics API#
Metrics-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Get VIA metrics in prometheus format. |
Models API#
Models-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Lists the currently available models, and provides basic information about each one such as the owner and availability. |
Recommended_config API#
Recommended_config-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Recommend config for a video. |
Summarize API#
Summarize-related APIs exposed by the service.
API Endpoint |
Description |
|---|---|
Run video summarization query. |
/alerts [GET]#
Summary: List all live stream alerts
Description: List all live stream alerts added to the VIA Server.
No parameters defined.
/alerts [POST]#
Summary: Add an alert
Description: Add an alert for a live stream.
Parameter |
Description |
|---|---|
name |
Name of the alert |
liveStreamId |
ID of the live stream to configure the alert for |
events |
List of events to generate alert for |
callback |
URL to call when events are detected |
callbackJsonTemplate |
JSON Template for the callback body with supported placeholders |
callbackToken |
Bearer token to use when calling the callback URL |
/alerts/{alert_id} [DELETE]#
Summary: Delete a live stream alert
Description: Delete a live stream alert added to the VIA Server.
Parameter |
Description |
|---|---|
alert_id |
Unique ID of the alert to be deleted. |
/alerts/recent [GET]#
Summary: Get recent alerts
Description: Get recently generated alerts. Optionally filter by live stream ID.
Parameter |
Description |
|---|---|
live_stream_id |
Optional live stream ID to filter alerts. |
/chat/completions [POST]#
Summary: VIA Chat or Q&A
Description: Run video interactive question and answer.
Parameter |
Description |
|---|---|
id |
Unique ID or list of IDs of the file(s)/live-stream(s) to query (max 50 items). Note: List of IDs work only for image files. |
messages |
List of chat messages containing the conversation history |
model |
Model to use for this query (e.g. “vila-1.5”) |
api_type |
API used to access model (e.g. “internal”) |
max_tokens |
Maximum number of tokens to generate (1-1024) |
temperature |
Sampling temperature for text generation (0-1) |
top_p |
Top-p sampling mass for text generation (0-1) |
top_k |
Number of highest probability tokens to keep (1-1000) |
seed |
Random seed for generation |
highlight |
If true, generate a highlight for the video |
/files [POST]#
Summary: API for uploading a media file
Description: Files are used to upload media files.
Parameter |
Description |
|---|---|
purpose |
The intended purpose of the uploaded file (must be “vision” for VIA use-case) |
media_type |
Media type (“image” or “video”) |
file |
File object to be uploaded |
filename |
Filename along with path to be used (alternative to file upload) |
/files [GET]#
Summary: Returns list of files
Description: Returns a list of files.
Parameter |
Description |
|---|---|
purpose |
Only return files with the given purpose. |
/files/{file_id} [DELETE]#
Summary: Delete a file
Description: The ID of the file to use for this request.
Parameter |
Description |
|---|---|
file_id |
File having ‘file_id’ to be deleted. |
/files/{file_id} [GET]#
Summary: Returns information about a specific file
Description: Returns information about a specific file.
Parameter |
Description |
|---|---|
file_id |
The ID of the file to use for this request. |
/files/{file_id}/content [GET]#
Summary: Returns the contents of the specified file
Description: Returns the contents of the specified file.
Parameter |
Description |
|---|---|
file_id |
The ID of the file to use for this request. |
/health/ready [GET]#
Summary: Get VIA readiness status
Description: Get VIA readiness status.
No parameters defined.
/health/live [GET]#
Summary: Get VIA liveness status
Description: Get VIA liveness status.
No parameters defined.
/live-stream [GET]#
Summary: List all live streams
Description: List all live streams.
No parameters defined.
/live-stream [POST]#
Summary: Add a live stream
Description: API for adding live / camera stream.
Parameter |
Description |
|---|---|
liveStreamUrl |
URL of the RTSP stream |
description |
Description of the live stream |
username |
Username for RTSP authentication (if required) |
password |
Password for RTSP authentication (if required) |
/live-stream/{stream_id} [DELETE]#
Summary: Remove a live stream
Description: API for removing live / camerea stream matching stream_id.
Parameter |
Description |
|---|---|
stream_id |
Unique identifier for the live stream to be deleted. |
/metrics [GET]#
Summary: Get VIA metrics
Description: Get VIA metrics in prometheus format.
No parameters defined.
/models [GET]#
Summary: Lists the currently available models, and provides basic information about each one such as the owner and availability
Description: Lists the currently available models, and provides basic information about each one such as the owner and availability.
No parameters defined.
/recommended_config [POST]#
Summary: Recommend config for a video
Description: Recommend config for a video.
No parameters defined.
/summarize [POST]#
Summary: Summarize a video
Description: Run video summarization query.
Parameter |
Description |
|---|---|
id |
Unique ID or list of IDs of the file(s)/live-stream(s) to summarize (max 50 items). Note: List of IDs work only for image files. |
prompt |
Prompt for summarization |
model |
Model to use for this query (e.g. “vila-1.5”) |
api_type |
Specifies the type of API |
response_format |
Specifies the format of the response(0 for json and 1 for text) |
stream |
If true, partial message deltas will be sent as server-sent events |
max_tokens |
Maximum number of tokens to generate (1-1024) |
temperature |
Sampling temperature for text generation (0-1) |
top_p |
Top-p sampling mass for text generation (0-1) |
top_k |
Number of highest probability tokens to keep (1-1000) |
seed |
Random seed for generation (1-4294967295) |
chunk_duration |
Chunk videos into chunks of specified duration in seconds (default: 0 for no chunking) |
chunk_overlap_duration |
Chunk overlap duration in seconds (default: 0 for no overlap) |
summary_duration |
Summarize every specified duration of video (applicable to live streams only. -1 for summary_duration till EOS) (-1, 3600) |
media_info |
media_info object that contains start and end times offsets for processing part of a video file. Not applicable for live-streaming |
user |
A unique identifier for the user |
caption_summarization_prompt |
Prompt for caption summarization |
summary_aggregation_prompt |
Prompt for summary aggregation |
tools |
Configuration of the tool to be used as part of the request. Currently, only alert is supported. |
enable_chat |
Enable chat Q&A on the input media |
enable_chat_history |
Enable chat history during Q&A |
enable_cv_metadata |
Enable CV metadata |
cv_pipeline_prompt |
Prompt for CV pipeline |
num_frames_per_chunk |
Number of frames per chunk for VLM (0-256) |
vlm_input_width |
VLM input width (0-4096) |
vlm_input_height |
VLM input height (0-4096) |
enable_audio |
Enable transcription of audio stream |
summarize_batch_size |
Summarization batch size (1-1024) |
rag_type |
Type of RAG (“graph-rag” or “vector-rag”) |
rag_top_k |
RAG top k results (1-1024) |
rag_batch_size |
RAG batch size (1-1024) |
summarize_max_tokens |
Maximum number of tokens for summarization (1,40) |
summarize_temperature |
Sampling temperature for summarization (0,1) |
summarize_top_p |
Top-p sampling mass for summarization (0,1) |
chat_max_tokens |
Maximum number of tokens for chat responses (1,40) |
chat_temperature |
Sampling temperature for chat responses (0,1) |
chat_top_p |
Top-p sampling mass for chat responses (0,1) |
notification_max_tokens |
Maximum number of tokens for notifications (1,40) |
notification_temperature |
Sampling temperature for notifications (0,1) |
notification_top_p |
Top-p sampling mass for notifications (0,1) |