Skip to main content
POST
Stream Triggers

Description

This endpoint is used to trigger volume changes in a running stream. Use this to adjust the mix or volume of a live stream in real time. See the Quickstart guide for usage context.

Authentication

This endpoint requires an API Key.
Include your API key in the x-api-key header:

Request

  • Method: POST
  • Endpoint: /v1/streams/{stream_id}/trigger
  • Path Parameter:
    • stream_id (string, required): ID of the stream
  • Body:

Response

  • Status: 200 OK
  • Content-Type: application/json

Example Usage (cURL)

Authorizations

X-API-Key
string
header
required

Path Parameters

stream_id
string
required

ID of the stream

Body

application/json
mix
string
required

Mix value for volume, must be between -128 and 128.

Response

200 - application/json

Successful Response

The response is of type string.