---
title: "Start a screen mirror session"
method: POST
path: "/v1/screens/{id}/mirror"
tags: ["screens"]
---

# Start a screen mirror session

`POST /v1/screens/{id}/mirror`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/screens/{id}/mirror`
- Auth: HTTP bearer

Start a live mirroring session for a screen. The response includes a signaling URL that a viewer connects to over WebRTC; the screen's device connects when it receives the corresponding command. End the session with POST /v1/mirror/:sessionId/end.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` object, required
    - `sessionId` string, required
    - `signalingUrl` string, required
    - `signalingToken` string, required: Viewer token for `signalingUrl`; valid for 5 minutes, for this session only.
    - `turnHint` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)