> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# Create a simulcast

POST https://api.fastpix.com/v1/live/streams/{streamId}/simulcast
Content-Type: application/json

Creates a simulcast for a parent live stream. Simulcasting allows you to broadcast a live stream to multiple social platforms simultaneously (for example, YouTube, Facebook, or Twitch). This helps expand your audience reach across platforms. A simulcast can only be created when the parent live stream is in the idle state (not currently live or disabled). Only one simulcast target can be created per API call.

#### How it works

1. Change to: When you call this endpoint, provide the parent `streamId` along with the simulcast target details (such as platform and credentials). The API returns a unique `simulcastId`, which you can use to manage the simulcast later.

2. To notify your application about the status of simulcast related events check for the webhooks for simulcast target events.

#### Example

An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it's in the idle state. Then, they use the API to create a simulcast target for YouTube.

Related guide: Simulcast to 3rd party platforms

Reference: https://fastpix.com/docs/live-stream-api/simulcast-stream/create-simulcast-of-stream

## Authentication

- `Authorization` header (basic auth, required) — FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. * Username: Access Token ID * Password: Secret Key Activate your FastPix account to generate your API credentials. See the guide here

## Request

### Path parameters

- `streamId` (string, required) — After creating a new live stream, FastPix assigns a unique identifier to the stream.

### Body (application/json)

This endpoint expects a simulcastRequest.

- `url` (string, required, default: rtmp://example.com/) — The RTMPS hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
- `streamKey` (string, required, default: d851d91d5b768b36k61a264dcc447b) — A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
- `metadata` (map from string to string, optional) — You can search for videos with specific key-value pairs using metadata, when you tag a video in "key":"value" pairs.

## Response

### 201

New Simulcast created successfully

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (SimulcastResponseData, optional) — Displays the result of the request.

## Types

### SimulcastResponseData

Displays the result of the request.

- `simulcastId` (string, optional) — When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
- `url` (string, optional) — The RTMPS hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
- `streamKey` (string, optional) — A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
- `isEnabled` (boolean, optional) — When the value is true, the simulcast must be enabled for the given stream
- `metadata` (map from string to string, optional) — You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

## Examples

**Request**

```json
{
  "url": "rtmp://hyd01.contribute.live-video.net/app/",
  "streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
  "metadata": {
    "livestream_name": "Tech-Connect Summit"
  }
}
```

**Response**

```json
{
  "success": true,
  "data": {
    "simulcastId": "8717422d89288ad5958d4a86e9afe2a2",
    "url": "rtmp://hyd01.contribute.live-video.net/app/",
    "streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
    "isEnabled": true,
    "metadata": {
      "livestream_name": "Tech-Connect Summit"
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast"

payload = {
    "url": "rtmp://hyd01.contribute.live-video.net/app/",
    "streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
    "metadata": { "livestream_name": "Tech-Connect Summit" }
}
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"url":"rtmp://hyd01.contribute.live-video.net/app/","streamKey":"live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk","metadata":{"livestream_name":"Tech-Connect Summit"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast"

	payload := strings.NewReader("{\n  \"url\": \"rtmp://hyd01.contribute.live-video.net/app/\",\n  \"streamKey\": \"live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk\",\n  \"metadata\": {\n    \"livestream_name\": \"Tech-Connect Summit\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<username>", "<password>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"rtmp://hyd01.contribute.live-video.net/app/\",\n  \"streamKey\": \"live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk\",\n  \"metadata\": {\n    \"livestream_name\": \"Tech-Connect Summit\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"rtmp://hyd01.contribute.live-video.net/app/\",\n  \"streamKey\": \"live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk\",\n  \"metadata\": {\n    \"livestream_name\": \"Tech-Connect Summit\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast', [
  'body' => '{
  "url": "rtmp://hyd01.contribute.live-video.net/app/",
  "streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
  "metadata": {
    "livestream_name": "Tech-Connect Summit"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"rtmp://hyd01.contribute.live-video.net/app/\",\n  \"streamKey\": \"live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk\",\n  \"metadata\": {\n    \"livestream_name\": \"Tech-Connect Summit\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "url": "rtmp://hyd01.contribute.live-video.net/app/",
  "streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
  "metadata": ["livestream_name": "Tech-Connect Summit"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```