API documentation

List all configurations.

Fetch a single configuration.

List all instances running this configuration.

Launch one or more instances of a configuration. Without a payload, one instance with default settings is started. The response includes a Location header pointing to the instance request.

The optional autoStop field controls idle behavior. Set true to always stop the instance after 5 minutes of no inputs or outputs, or after 15 minutes of active outputs with no inputs, false to keep the instance running indefinitely, or omit it to use the account-level auto-stop settings.

{
    "numberOfInstances": 1,
    "autoStop": false,
    "instanceSettings": [
        {
            "name": "Instance name",
            "overrides": {
                "htmloverlay-1": {"url": "https://example.com"},
                "inputstream-1": {"pullUrl": "rtmp://customserver"},
                "outputstream-1": {"destinations": ["destination-id"]}
            }
        }
    ]
}

Response header: Location: /api/v1/instance-requests/{requestId}

Set all output destinations live or offline for all instances running this configuration.

{ "outputs": "LIVE" | "OFFLINE" }

Stop all running or queued instances for this configuration.

Fetch an instance request by ID to check its status.

List all instances.

Fetch a single instance.

Stop all instances.

Stop a specific instance.

Restart a specific instance.

Get the current setting overrides for an instance.

Update setting overrides for a running instance. Changes apply immediately.

{
    "htmloverlay-1": {"url": "https://example.com", "visible": true},
    "switch-1": {"activeInput": 2}
}

List all output stream elements for a running instance with their current state.

{
    "outputs": [
        {
            "id": "outputstream-1",
            "type": "outputstream",
            "health": "OK",
            "state": {
                "destinations": [
                    { "id": "dest-1", "status": "LIVE" }
                ]
            }
        }
    ]
}

Set all output destinations for an instance to LIVE or OFFLINE.

{ "desiredState": "LIVE" | "OFFLINE" }

Set all destinations for a specific output element to LIVE or OFFLINE.

{ "desiredState": "LIVE" | "OFFLINE" }

Set a single destination within a specific output element to LIVE or OFFLINE.

{ "desiredState": "LIVE" | "OFFLINE" }

{
    "elementId": "string",
    "action": "string",
    "params": {}
}

Get the credit balance plus the real-time cost of running streams. The balance only changes once a stream stops, so runningStreamsCostCents reports what live streams have accrued so far. This is an estimate that becomes an actual charge when the stream stops. creditsRemainingRealtimeCents is the balance with that in-flight cost already subtracted.

{
  "creditsRemainingCents": 1240,
  "runningStreamsCostCents": 87,
  "runningStreamsCount": 2,
  "creditsRemainingRealtimeCents": 1153
}

List all destinations.

List the streaming platforms predefined in Streamrun. Platforms with a server address only need a streamKey when creating a destination. Platforms where requiresUrl is true need a custom url.

{
    "platforms": [
        { "platform": "Twitch", "server": "rtmp://...", "requiresUrl": false, "link": "https://..." },
        { "platform": "Custom", "server": null, "requiresUrl": true, "link": null }
    ]
}

Add a new destination. Provide a streamKey (for a built-in platform), a custom url, or both.

{
    "platform": "Custom",
    "name": "My server",
    "url": "rtmp://live.example.com/app",
    "streamKey": "abc123"
}

Update an existing destination. Every field is optional; only the fields you send are changed.

Delete a destination.