Red5

Red5 provides real-time streaming infrastructure for live video and audio delivery at scale. The Red5 Pro platform includes a media server, Stream Manager 2.0 for autoscaling cloud deployments, the Brew Mixer for composite stream production, a Restreamer for pushing live streams to social media and RTMP destinations, and WebRTC and native SDKs for browser and mobile integration. Red5 APIs enable programmatic management of streams, mixers, restreaming, cluster orchestration, and node monitoring. Use cases include live events, sports broadcasting, interactive video, gaming, surveillance, and enterprise communications requiring ultra-low latency streaming.

8 APIs 0 Features

Live StreamingMediaReal-TimeRTMPStreamingVideoWebRTC

APIs

Red5 Pro Server API

The Red5 Pro Server API is an HTTP-based REST API for gathering server, application, client, and stream statistics from a running Red5 Pro instance. It exposes endpoints for ser...

Red5 Pro Stream Manager 2.0 API

The Red5 Pro Stream Manager 2.0 API orchestrates autoscaling clusters of Red5 Pro streaming nodes across cloud infrastructure. It provides REST endpoints for managing live strea...

Red5 Pro Brew Mixer API

The Red5 Pro Brew Mixer API is a REST interface for the Cauldron Media Engine that enables dynamic composition of multiple live video and audio streams into a single mixed outpu...

Red5 Pro Restreamer API

The Red5 Pro Restreamer API controls live stream retransmission to external RTMP, RTMPS, SRT, and Zixi destinations including social media platforms like Facebook, YouTube, and ...

Red5 Pro WebRTC SDK

The Red5 Pro WebRTC SDK is a JavaScript library for integrating low-latency live streaming publish and subscribe capabilities into web applications. It supports WHIP for WebRTC ...

Red5 Core SDK

The Red5 Core SDK is a native client library for building real-time streaming applications on Linux, Windows, and macOS desktop platforms. It offers interfaces for server connec...

Red5 Pro iOS Streaming SDK

The Red5 Pro iOS Streaming SDK is a native iOS library for integrating real-time live streaming publish and subscribe capabilities into iOS applications. It supports H.264 video...

Red5 Pro Android Streaming SDK

The Red5 Pro Android Streaming SDK is a native Android library for integrating real-time live streaming publish and subscribe capabilities into Android applications. It supports...

Collections

Red5 Pro Brew Mixer API

OPEN

Red5 Pro Restreamer API

OPEN

Red5 Pro Server API

OPEN

Red5 Pro Stream Manager 2.0 API

OPEN

Pricing Plans

Red5 Plans Pricing

2 plans

PLANS

Rate Limits

Red5 Rate Limits

2 limits

RATE LIMITS

FinOps

Red5 Finops

FINOPS

Event Specifications

Red5 Pro WebRTC Streaming Events

AsyncAPI specification for the Red5 Pro WebRTC streaming event system, covering WebSocket signaling messages exchanged during publish and subscribe sessions. Red5 Pro WebRTC use...

ASYNCAPI

Semantic Vocabularies

Red5 Context

0 classes · 9 properties

JSON-LD

API Governance Rules

Red5 API Rules

11 rules · 3 errors 8 warnings

SPECTRAL

JSON Structure

Red5 Stream Structure

0 properties

JSON STRUCTURE

Example Payloads

Red5 Server Api List Streams Example

2 fields

EXAMPLE

Red5 Stream Manager Create Provision Example

2 fields

EXAMPLE

Resources

Documentation

GitHubOrganization

GitHubOrganization

GitHubOrganization

GitHubOrganization

JSONLDContext

JSONStructure

SpectralRuleset

SpectralRuleset

Sources

opencollection: 1.0.0
info:
  name: Red5 Pro Stream Manager 2.0 API
  version: '2.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Streams
    type: folder
  items:
  - info:
      name: Get Publish Stream Endpoint
      type: http
    http:
      method: GET
      url: https://{streamManagerDomain}/as/v1/streams/stream/:nodeGroupName/publish/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
    docs: Returns the connection details for a publisher to connect to the correct Red5 Pro node for broadcasting a stream.
      The Stream Manager selects an appropriate node based on load and availability within the specified node group.
  - info:
      name: Get Subscribe Stream Endpoint
      type: http
    http:
      method: GET
      url: https://{streamManagerDomain}/as/v1/streams/stream/:nodeGroupName/subscribe/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
    docs: Returns the connection details for a subscriber to connect to the correct Red5 Pro node for consuming a live stream.
      Routes subscribers to nodes that have the stream available within the specified node group.
- info:
    name: Provision
    type: folder
  items:
  - info:
      name: Get Stream Provision
      type: http
    http:
      method: GET
      url: https://{streamManagerDomain}/as/v1/streams/provision/:nodeGroupName/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
    docs: Retrieves the provisioning configuration for a specific stream including authentication settings, cloud recording
      configuration, and transcoding parameters.
  - info:
      name: Create Stream Provision
      type: http
    http:
      method: POST
      url: https://{streamManagerDomain}/as/v1/streams/provision/:nodeGroupName/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
      body:
        type: json
        data: '{}'
    docs: Creates a provisioning configuration for a stream, setting up authentication credentials, cloud storage for recordings,
      transcoding ladder settings, and other stream-level parameters before publishing begins.
  - info:
      name: Delete Stream Provision
      type: http
    http:
      method: DELETE
      url: https://{streamManagerDomain}/as/v1/streams/provision/:nodeGroupName/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
    docs: Removes the provisioning configuration for a stream, clearing authentication settings, cloud recording configuration,
      and transcoding parameters.
- info:
    name: Admin
    type: folder
  items:
  - info:
      name: List Node Groups
      type: http
    http:
      method: GET
      url: https://{streamManagerDomain}/as/v1/admin/nodegroups
    docs: Returns all configured node groups in the Stream Manager cluster, including their scaling configuration, cloud provider
      settings, and current node counts.
  - info:
      name: List Nodes in a Node Group
      type: http
    http:
      method: GET
      url: https://{streamManagerDomain}/as/v1/admin/nodegroups/:nodeGroupName/nodes
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
    docs: Returns all streaming nodes currently active in the specified node group, including their IP addresses, current
      load metrics, and operational status.
  - info:
      name: Get System Information
      type: http
    http:
      method: GET
      url: https://{streamManagerDomain}/as/v1/admin/system
    docs: Returns system-level information about the Stream Manager instance including version, Java runtime details, memory
      usage, and overall cluster health.
- info:
    name: Proxy
    type: folder
  items:
  - info:
      name: Whip Publish Endpoint
      type: http
    http:
      method: POST
      url: https://{streamManagerDomain}/as/v1/proxy/whip/:nodeGroupName/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
    docs: WebRTC-HTTP Ingestion Protocol (WHIP) endpoint for publishing a WebRTC stream through the Stream Manager proxy.
      Accepts an SDP offer and returns an SDP answer along with routing information to the selected streaming node.
  - info:
      name: Whep Subscribe Endpoint
      type: http
    http:
      method: POST
      url: https://{streamManagerDomain}/as/v1/proxy/whep/:nodeGroupName/:streamGuid
      params:
      - name: nodeGroupName
        value: ''
        type: path
        description: Name of the node group (cluster) to target
      - name: streamGuid
        value: ''
        type: path
        description: Unique identifier (GUID) for the stream
    docs: WebRTC-HTTP Egress Protocol (WHEP) endpoint for subscribing to a live stream through the Stream Manager proxy. Accepts
      an SDP offer and returns an SDP answer routing the subscriber to the node carrying the requested stream.
bundled: true