> This page is for version Dev.
> 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.

# VST Live Stream Management API Reference

> The Live Stream Service is designed to facilitate the live or real time streaming of sensors. This service encompasses:  - Live streaming: Live streaming of sensors using WebRTC pr

REST endpoints for the VST Live Stream Management service.

The machine-readable OpenAPI specification is `services/vios/doc/api/vst_live_stream_ms/swagger.yaml` in this repository.

**Servers:** `https://localhost/api`

## Endpoint catalog

### v1

| Method | Endpoint                                 | Summary                                                        |
| ------ | ---------------------------------------- | -------------------------------------------------------------- |
| `GET`  | `/v1/live/streams`                       | Get list of available live streams                             |
| `POST` | `/v1/live/stream/settings`               | Set stream settings                                            |
| `GET`  | `/v1/live/stream/query`                  | Query live stream for timestamp and metadata                   |
| `POST` | `/v1/live/stream/start`                  | Start live WebRTC streaming                                    |
| `POST` | `/v1/live/stream/swap`                   | Switch stream type from recorded to live                       |
| `POST` | `/v1/live/stream/stop`                   | Stop live WebRTC streaming                                     |
| `POST` | `/v1/live/stream/pause`                  | Pause the live stream WebRTC playback                          |
| `POST` | `/v1/live/stream/resume`                 | Resume the live stream WebRTC playback                         |
| `GET`  | `/v1/live/stream/status`                 | Get live stream playback status                                |
| `GET`  | `/v1/live/stream/{streamId}/picture`     | Get picture or snapshot of live streaming                      |
| `GET`  | `/v1/live/stream/{streamId}/picture/url` | Get temporary URL for accessing live picture                   |
| `GET`  | `/v1/live/stream/stats`                  | Get live stream stats                                          |
| `POST` | `/v1/live/setAnswer`                     | Share SDP answer with live streaming service                   |
| `POST` | `/v1/live/iceCandidate`                  | Share client's ICE candidate with live streaming service       |
| `GET`  | `/v1/live/iceCandidate`                  | Get list of ICE Candidates generated by live streaming service |
| `GET`  | `/v1/live/iceServers`                    | Get list of ICE servers                                        |
| `GET`  | `/v1/live/configuration`                 | Get live stream service configuration                          |
| `POST` | `/v1/live/configuration`                 | Set live stream service configuration                          |
| `GET`  | `/v1/live/version`                       | Get live stream service version                                |
| `GET`  | `/v1/live/help`                          | Get list of supported APIs by live stream service              |