CAcamb
Apis
Streaming

Create Flow

Create a stream flow: a standing SRT endpoint, independent of any stream, that you can use as the source or a target of streams. In listener mode Camb.ai hosts an endpoint your encoder pushes to; in caller mode Camb.ai pulls from your upstream and re-serves it.

post/flows

Request

  • Base URL
    https://client.camb.ai/apis
  • URL
    https://client.camb.ai/apis/flows
  • Auth
    API key in header x-api-key

Request body

labelstring required

Human-readable name for the flow. Must be unique within your team.

mode'caller' | 'listener' required

caller: Camb.ai connects out to your SRT endpoint (primary_url) and re-serves it. listener: Camb.ai hosts an SRT endpoint that your encoder pushes to.

failoverboolean

Enable a second (backup) leg. Caller flows then require backup_url; listener flows get a backup push URL.

primary_urlstring nullable

SRT URL of your upstream (caller mode only; required there, forbidden for listeners). To dial an encrypted upstream, append its passphrase as a query parameter: srt://host:port?passphrase=....

backup_urlstring nullable

SRT URL of the backup upstream. Caller mode with failover enabled only.

passphrasestring nullable

Optional SRT encryption passphrase for the flow's own endpoint (10-79 characters). When set, it is embedded in the returned play/push URLs and required to connect.

Response

The created flow, including its play and push URLs.

idinteger

Flow identifier.

labelstring
mode'caller' | 'listener'

caller: Camb.ai connects out to your SRT endpoint (primary_url) and re-serves it. listener: Camb.ai hosts an SRT endpoint that your encoder pushes to.

failoverboolean
activeboolean

Whether the flow's relay is currently online.

team_idinteger
keystring

Access key embedded in the flow's URLs.

play_urlstring

SRT URL the flow serves. Use it as source_stream.url or as a target_streams[].url, or play it directly.

passphrasestring nullable

The flow's SRT encryption passphrase, when one is set.

Changes

No recorded changes to this operation across all 1 revision of this API.