Skip to main content
GET

Overview

Returns the full details of one flow, including its play_url, push_urls, access key, the region hosting its endpoint, and any egress destinations (egress_primary_url, egress_backup_url) exactly as you set them.

Errors

  • 404 - No flow with this ID belongs to your team.

Authorizations

x-api-key
string
header
required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

flow_id
integer
required

Identifier of the flow.

Response

The flow.

id
integer

Flow identifier.

label
string
mode
enum<string>

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.

Available options:
caller,
listener
failover
boolean
active
boolean

Whether the flow's relay is currently online.

team_id
integer
region
string | null

Region hosting the flow's SRT endpoint, as chosen at create. The flow's URLs carry this region's address.

key
string

Access key embedded in the flow's URLs.

play_url
string

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

push_urls
PushUrl ยท object[]

SRT URLs to push into (listener mode). Empty for caller flows.

passphrase
string | null

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

egress_primary_url
string | null

The primary egress destination as you set it, including any query parameters, or null.

egress_backup_url
string | null

The backup egress destination as you set it, or null.

Last modified on October 28, 2026