Create room stream

POST

https://{your_space_name}.signalwire.com/api/video/rooms/:id/streams

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Starts an outbound RTMP or RTMPS stream from a Video Room to the supplied ingest URL. Use it to broadcast a room to an external streaming destination. For live voice-call audio sent over WebSocket, use the Compatibility API's [Create stream](/docs/compatibility-api/rest/streams/create-stream) operation instead. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the video room.

Request

This endpoint expects an object.

urlstringRequired

RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.

Response

Stream created response.

idstringformat: "uuid"

Unique identifier for the stream.

urlstring or null

RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.

stream_typestring or null

The type of stream.

widthinteger or null

The stream's width in pixels.

heightinteger or null

The stream's height in pixels.

fpsinteger or null

The stream's frames per second.

created_atdatetime

Timestamp when the stream was created.

updated_atdatetime

Timestamp when the stream was last updated.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://{your_space_name}.signalwire.com/api/video/rooms/id/streams \
>	-H "Content-Type: application/json" \
>	-u "<project_id>:<api_token>" \
>	-d '{
>	"url": "rtmp://broadcaster"
>	}'

1	{
2	"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3	"url": "rtmp://broadcaster",
4	"stream_type": "rtmp",
5	"width": 1920,
6	"height": 1080,
7	"fps": 20,
8	"created_at": "2022-01-01T10:00:00Z",
9	"updated_at": "2022-01-01T11:00:00Z"
10	}