Skip to main content
POST
Launch Media Pipeline (RTMP Channel)

Description

This endpoint is used to create a new RTMP channel. It returns the RTMP server URL and stream key, which you will use in your streaming software (such as OBS Studio) to broadcast your stream. After creating the channel, use the Launch Stream endpoint to start the RTMP stream. See the Quickstart guide for the full workflow.

Authentication

This endpoint requires an API Key.
Include your API key in the X-Api-Key header:

Request

  • Method: POST
  • Endpoint: /v1/rtmp_channel
  • Content-Type: application/json

Request Body

Request Body Parameters

Response

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

Example Usage (cURL)

Authorizations

X-API-Key
string
header
required

Body

application/json
output_rtmp_url
string
required
output_stream_key
string
required

Response

200 - application/json

Successful Response

The response is of type object.