Skip to main content
POST
Create a channel

Authorizations

Authorization
string
header
required

A platform API key, presented as Authorization: Bearer <API_KEY>. Each operation says which permission the key needs.

Path Parameters

space_id
string<uuid>
required

The space to act in.

Body

application/json
name
string
required

Identifies the channel.

Required string length: 1 - 512
Example:

"Studio channel 1"

source_id
string<uuid>
required

The live source the channel records, of any UUID version.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
auto_shutdown
object

When the channel deactivates itself.

description
string
Example:

"Records the studio floor camera."

recording_trigger
object

The SCTE-35 cues that start and stop recording.

region
string
Maximum string length: 30
settings
object

How the channel should behave beyond recording. It has to follow the channel settings schema of the engine version the channel records with; a document that does not is refused.

tags
string[]
Maximum array length: 64
Maximum string length: 128
Example:

Response

The created channel.

A channel's configuration and lifecycle state. Its recording settings and its recordings are separate sub-resources, so listing channels stays a single query.

description
string
required
id
string<uuid>
required
name
string
required
pinned
boolean
required
read-only

Whether the channel is pinned to the top of the list. Read-only; no operation sets it.

source_id
string<uuid>
required

The live source the channel records.

status
enum<string>
required

draft is not fully configured and cannot be activated; inactive is configured but not activated; pending is being provisioned; active can record its source.

Available options:
draft,
inactive,
pending,
active
activated_at
string<date-time>
auto_shutdown
object

When the channel deactivates itself.

recording_trigger
object

The SCTE-35 cues that start and stop recording.

region
string

Where the recording worker is placed.

settings
object

How the channel behaves beyond recording. Its shape is the channel settings schema of the engine version the channel records with.

tags
string[]