Skip to content
Wowza Video Intelligence...
/
/Media/
Get a stream thumbnail

Wowza Video Intelligence Framework (VIF) REST API

The Video Intelligence Framework (VIF) adds real-time, AI-powered object detection, scene analysis, and event-driven intelligence to live video streams running on Wowza Streaming Engine (WSE).

This REST API lets you inspect system and per-stream status, read and update the default configuration, manage the active (in-memory) and saved (on-disk) configuration of individual streams, and retrieve annotated thumbnails.

VIF WSE plugin reference

Configuration hierarchy

Settings cascade through three levels of increasing specificity: Defaults (/v1/{server}/plugin/vif/config) → Stream pattern → Single stream. A more specific setting overrides a less specific one.

Active vs. saved configuration

  • Active config (/v1/{server}/plugin/vif/applications/{appName}/streams/{streamName}) is the configuration currently applied in memory to a running stream. Supports GET and PUT.

  • Saved config (/v1/{server}/plugin/vif/applications/{appName}/streams/{streamName}/config) is the persisted configuration in video-intelligence.json. Supports GET, PUT, POST, and DELETE.

Authentication

All requests use HTTP Basic authentication with Wowza Streaming Engine Manager credentials.

Download OpenAPI description
vif-openapi-3.1.json
vif-openapi-3.1.yaml
Overview
URL
https://www.wowza.com/docs
License
Wowza
Languages
Servers
Local Wowza Streaming Engine REST API
http://localhost:8087
Custom Wowza Streaming Engine host
http://{host}:{port}

Status & Health

Monitor VIF system and per-stream health and performance.

Operations

Configuration

Read and update the default VIF configuration.

Operations

Stream Management

Manage the active and saved configuration of individual streams.

Operations

Media

Retrieve annotated media such as thumbnails.

Operations

Get a stream thumbnail

Request

Returns a thumbnail image (JPEG) for the stream. Optionally include graphical detection overlays and select a specific buffered frame.

Security
basicAuth
Path
serverstringrequired

WSE server name. Any value is accepted; commonly _defaultServer_.

Default "_defaultServer_"
appNamestringrequired

Name of the Wowza application the stream is running on (e.g. live).

streamNamestringrequired

Stream name or a stream pattern (regex) used to match streams, e.g. objects.*.

Query
overlayboolean

When true, render detection overlays onto the returned image.

Default false
frameIdinteger>= 0

Frame identifier to retrieve from the buffer. 0 is the latest frame.

Default 0
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v1/http://localhost:8087/plugin/vif/applications/{appName}/streams/{streamName}/thumbnail?overlay=false&frameId=0'

Responses

Thumbnail image returned successfully.

Body
string(binary)
Response
No content