Pricing Sign in Start in the cloud for free

Command-first documentation

Search the module, then move faster through the API

Find the exact module, copy the working request shape, and move from product workflow to API call without getting buried in the tree.

AI workflow helperDescribe what you want to buildOptional tool

Write the workflow in plain language. We will turn it into a GPT-ready brief you can use to generate requests, module order, and starter payloads.

Multiview

On this page

Find an endpoint

12 endpoints

Search current page endpoints by name, HTTP verb, or URL

Search by endpoint name, HTTP verb, or URL, then jump straight to its request.

Multiview NDI configuration Restreams

Multiview is the Engine module for building an operator monitoring wall from SRT, RTMP, or NDI inputs. The API stores the layout and input map, creates the conference-backed viewing surface, and keeps the runtime restreams aligned with the saved resource.

Multiview lifecycle

Create the wall, attach inputs, and give operators a join path

Lifecycle

Multiview coordinates input restreams with a conference-backed viewing surface. The public endpoints are only valid for a resource whose visibility is PUBLIC.

01Create
POST /api/multiview/create
Choose layout, visibility, inputs, and whether the runtime starts immediately.
02Inspect
POST /api/multiview/getById
Read the saved input and conference bindings before sharing access.
03Join
POST /api/multiview/join
Issue a participant token for the authenticated operator workflow.
04Observe
POST /api/multiview-public/getStat
For a public wall, read the runtime statistics associated with its input restreams.

Animated values illustrate request order; endpoint and payload contracts below are source-synced with Engine 8.7.

Use the protected workflow first

Create a private wall with POST /api/multiview/create. Starting with inputs: [] is valid when you want to reserve the layout before attaching feeds.
Update the complete desired input list. Inputs removed from the next list are detached from the runtime by the service.
Start the wall, then call the authenticated join endpoint to receive the conference room and participant token.
Use getById and the input runtime statistics to confirm the saved state and media process agree.

Public access is an explicit product choice

Public read, statistics, and join endpoints do not use x-access-token, but they return data only for a resource saved with visibility: PUBLIC. A public join may start the wall when its runtime is not ready. Treat the public id as shareable access material, apply rate limiting at the edge, and do not publish ids for private operations.

The Engine also contains an unauthenticated public-start route. It is intentionally not promoted here until its abuse-control policy is reviewed; use protected /api/multiview/start for operator automation.

Common 400 response

Validation and lookup failures use the normal Engine error shape: { success: false, status, code, message, details }. Do not retry a validation failure until the required id, name, visibility, or participant fields are corrected.

Source binding: this page is reviewed against Engine 8.7@ef3dd337. Uncommitted phone-publish and AV mixer routes are not part of this public contract.

POST

/api/multiview/create

API token required

Create the saved wall and, when active is not false, prepare its conference/runtime. The authenticated user id is injected from the token; do not send user_id.

Next call: use getById to confirm normalized inputs, then join for an operator token.

A 400 response uses { success: false, status, code, message, details }.

Request body parameters

Identity

name

string

Required operator-facing name, 1–120 characters.

Layout

layout_id

string

Optional layout identifier. The Engine defaults to 4-tiles.

overlay_settings

object

Optional overlay configuration stored with the wall.

Inputs

inputs

array

Optional input definitions. Supported runtime source kinds include SRT, RTMP, and NDI variants; start with an empty array when you want to provision the wall before attaching feeds.

Access

visibility

string

Optional PRIVATE or PUBLIC. The default is PRIVATE.

Runtime

active

boolean

Optional initial runtime state. Defaults to active unless explicitly set to false.

Create multiview

Response

Identity

string

Stable multiview identifier.

name

string

Operator-facing name.

Layout

layout_id

string

Selected tile layout, for example 4-tiles.

inputs

array

Normalized video inputs and their runtime bindings.

Access

visibility

string

PRIVATE or PUBLIC.

Runtime

conference_id

string

Conference backing the operator viewing surface.

active

boolean

Whether the multiview runtime should be active.

Response: Create multiview

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview/update

API token required

Update a multiview with its complete desired state. The service synchronizes runtime inputs and removes detached restreams, so read the current object before replacing a non-empty input list.

The authenticated user scope is added by the Engine. Unknown ids or invalid input fields return the common 400 error object.

Request body parameters

Resource

string

Multiview resource identifier.

Identity

name

string

Required updated name.

Layout

layout_id

string

Updated layout identifier.

overlay_settings

object

Updated overlay configuration.

Inputs

inputs

array

Complete desired input list. Runtime restreams detached from the next list are cleaned up by the service.

Access

visibility

string

PRIVATE or PUBLIC.

Runtime

active

boolean

Updated active state.

Update multiview

curl --request POST \
  --url http://localhost/api/multiview/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "MULTIVIEW_ID",
  "name": "Master control multiview",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "SRT_SERVER_ID",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0
    }
  ],
  "active": true
}'

Response

Identity

string

Stable multiview identifier.

name

string

Operator-facing name.

Layout

layout_id

string

Selected tile layout, for example 4-tiles.

inputs

array

Normalized video inputs and their runtime bindings.

Access

visibility

string

PRIVATE or PUBLIC.

Runtime

conference_id

string

Conference backing the operator viewing surface.

active

boolean

Whether the multiview runtime should be active.

Response: Update multiview

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview/getCount

API token required

POST

/api/multiview/getAll

API token required

List the authenticated user's multiview resources with optional pagination, sorting, and filtering. The response is a bare array.

Use getById when you are about to update or join one resource.

Request body parameters

Pagination

limit

number

Optional maximum rows.

skip

number

Optional rows to skip.

Ordering

sort

object

Optional sort object; the default is creation time ascending.

Filtering

filter

object

Optional filter, always combined with the authenticated user scope.

Get all multiviews

Response

Result

[]

array

Array of multiview resources.

Identity

string

Stable multiview identifier.

name

string

Operator-facing name.

Layout

layout_id

string

Selected tile layout, for example 4-tiles.

inputs

array

Normalized video inputs and their runtime bindings.

Access

visibility

string

PRIVATE or PUBLIC.

Runtime

conference_id

string

Conference backing the operator viewing surface.

active

boolean

Whether the multiview runtime should be active.

Response: Get all multiviews

JSON

[
  {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PRIVATE",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  }
]

POST

/api/multiview/getById

API token required

Read one multiview inside the authenticated user scope. This is the safest preflight before an update, start, stop, or join operation.

An unknown or foreign id returns the common Engine 400 error object.

Request body parameters

Resource

string

Multiview resource identifier.

Get multiview by id

Response

Identity

string

Stable multiview identifier.

name

string

Operator-facing name.

Layout

layout_id

string

Selected tile layout, for example 4-tiles.

inputs

array

Normalized video inputs and their runtime bindings.

Access

visibility

string

PRIVATE or PUBLIC.

Runtime

conference_id

string

Conference backing the operator viewing surface.

active

boolean

Whether the multiview runtime should be active.

Response: Get multiview by id

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview/start

API token required

POST

/api/multiview/stop

API token required

POST

/api/multiview/join

API token required

Issue an operator participant token for a multiview owned by the authenticated user. If the runtime is not ready, the service starts and synchronizes it before creating the token.

Keep participant_token out of logs and browser persistence; it is runtime access material.

Request body parameters

Resource

string

Multiview resource identifier.

Participant

participant_name

string

Required participant display name.

participant_id

string

Optional stable participant id. The Engine generates one when omitted.

Join multiview as an authenticated operator

Response

Join result

participant_token

string

LiveKit participant token for the multiview conference.

LKRoomName

string

Runtime room name.

participant_id

string

Resolved participant identity.

multiview

object

Current multiview resource.

Response: Join multiview as an authenticated operator

JSON

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PRIVATE",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PRIVATE",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

POST

/api/multiview-public/getById

Public endpoint

Read a multiview without an API token only when its saved visibility is PUBLIC. This route is intended for a deliberately shared viewing surface, not for control-plane automation.

An unknown or private id returns the common 400 error object.

Request body parameters

Resource

string

Multiview resource identifier.

Get public multiview by id

Response

Identity

string

Stable multiview identifier.

name

string

Operator-facing name.

Layout

layout_id

string

Selected tile layout, for example 4-tiles.

inputs

array

Normalized video inputs and their runtime bindings.

Access

visibility

string

PRIVATE or PUBLIC.

Runtime

conference_id

string

Conference backing the operator viewing surface.

active

boolean

Whether the multiview runtime should be active.

Response: Get public multiview by id

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PUBLIC",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview-public/getStat

Public endpoint

POST

/api/multiview-public/join

Public endpoint

Join a deliberately public multiview without an API token. The route can prepare the runtime before issuing a participant token, so protect it with edge rate limits and share only intentional public ids.

Treat the returned participant token as transient access material.

Request body parameters

Resource

string

Multiview resource identifier.

Participant

participant_name

string

Required guest display name.

participant_id

string

Optional stable participant id.

Join a public multiview

Response

Join result

participant_token

string

LiveKit token for the public multiview conference.

LKRoomName

string

Runtime room name.

participant_id

string

Resolved participant identity.

Response: Join a public multiview

JSON

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PUBLIC",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PUBLIC",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

DELETE

/api/multiview/remove

API token required

Back toNDI configuration Next toRestreams