--- title: "Get a channel by ID" method: GET path: "/channels/{id}" tags: ["Channels"] --- # Get a channel by ID `GET /channels/{id}` ## Path parameters - `id` string, required — Channel ID ## Query parameters - `include` string — Comma-separated list of related resources to include. Valid values: `ingests`, `engines`, `distributions` ## Response `200` The requested channel - ChannelObjectResultWithIncludes - `data` object, required — Channel object - `id` string, required — Unique identifier of the channel - `createdAt` string, required — Creation timestamp - `name` string, required — Name of the channel - `status` 'ready' | 'stopped' | 'deploying' | 'starting' | 'waiting' | 'ingesting' | 'playing' | 'stopping' | 'error' | 'deleting' | 'deleted', required — Current status of the channel - `externalId` string — Deprecated, use 'externalIds' instead. For now, this returns the first entry of the 'externalIds' list. - `externalIds` string[] — External identifiers of the channel - `timeout` number, required — Timeout in seconds - `ads` object — OptiView Ads configuration - `enabled` boolean, required — Whether OptiView ads are enabled on the channel - `settings` object — Deprecated. Only returned for channels still using the old (V1) ads API underneath. - `assetKey` string — Deprecated. Use customAssetKey instead. - `layout` 'SINGLE' | 'DOUBLE' | 'LSHAPE_AD' | 'LSHAPE_CONTENT' - `enableBumperAds` boolean - `podDuration` number - `customAdTagParameters` object - `dvr` object — DVR configuration - `enabled` boolean, required — Whether DVR is enabled - `windowInSeconds` number — DVR window in seconds (60-86400) - `nielsen` object — Nielsen configuration - `enabled` boolean, required — Whether Nielsen is enabled - `instreamMetadata` object — Instream metadata configuration - `enabled` boolean, required — Whether instream metadata is enabled. Supported metadata is h264 registered or unregistered SEI metadata - `uuids` string[] — Array of instream metadata SEI UUIDs - `perpetual` boolean, required — Whether this channel is 24/7 (never times out, excluded from transcoding analytics) - `organizationId` string, required — Organization ID - `ingests` IncludedIngests — Included ingests preview - `data` Ingest[], required — First 10 ingests - `id` string, required — Unique identifier of the ingest - `name` string, required — Name of the ingest - `createdAt` string, required — Creation timestamp - `type` 'rtmp-push' | 'rtmp-pull' | 'srt-pull' | 'srt-push' | 'sdi-pull', required — Ingest type - `url` string, required — Ingest URL - `streamKey` string — Stream key for RTMP push ingests - `tracks` object, required — Audio track configuration - `audio` object[] — Audio track configuration - `pid` number — Audio track PID (mandatory for multi-audio) - `language` string, required — Audio track language code - `label` string, required — Audio track label - `captions` object[], required — Caption configuration - `channel` number, required — Caption channel number - `language` string, required — Caption language code - `label` string — Caption label - `enhancements` SpeechEnhancement[] — Enhancement configuration - `kind` 'speech', required — Live speech translation of the stream audio (requires translations to be enabled for the organization) - `sourceLanguage` string, required — Source language spoken in the stream - `targetTextTracks` string[], required — Languages to generate translated text tracks for (max 5). A text track in the source language is included by default, so it must not be listed here - `sourceAudioTrack` integer — PID of the audio track to use as translation source - `dictionary` string, nullable — Speech dictionary ID (see `/enhancements/speech/dictionaries`). The dictionary helps the speech recognition caption the source audio and must have the same `language` as `sourceLanguage`. Can always be set to null to disconnect the dictionary - `latencyMode` 'fastest' | 'fast' | 'balanced' | 'highest' — Latency/quality trade-off of the translation. Defaults to 'fast' - `extraPrompt` string, nullable — Extra context for the AI generating the translated outputs, applied to every translation (e.g. 'this is a live horse race' or 'remove profane language from the output'). Can always be set to null to remove it - `position` object — Position of the rendered translated captions - `bottom` integer — Pixels from bottom - `hasMore` boolean, required — Whether there are more than 10 ingests - `link` string, required — Link to the full ingests list - `count` number, required — Total number of ingests - `engines` IncludedEngines — Included engines preview - `data` object[], required — First 10 engines - `id` string, required — Unique identifier of the engine - `name` string, required — Name of the engine - `createdAt` string, required — Creation timestamp - `updatedAt` string, required — Last update timestamp - `quality` object, required — Quality configuration - `abrLadderId` string, required — ABR ladder ID - `overlays` object[], required — Image overlay configuration - `url` string, required — URL of the overlay image - `position` object — Overlay position - `top` integer — Pixels from top - `bottom` integer — Pixels from bottom (ignored if top is present) - `left` integer — Pixels from left - `right` integer — Pixels from right (ignored if left is present) - `size` object — Overlay size - `width` integer — Width in pixels - `height` integer — Height in pixels - `opacity` number — Overlay opacity (`0`=fully transparent, `1`=fully opaque) - `drm` boolean, required — Whether DRM is enabled - `priority` number, required — Engine priority - `status` 'stopped' | 'deploying' | 'starting' | 'waiting' | 'ingesting' | 'playing' | 'stopping' | 'error' | 'deleting' | 'deleted', required — Current status of the engine - `daiAssetKey` string, nullable — DAI asset key - `outputs` object, required — Output format configuration - `hesp` boolean — Enable HESP output. Enabled by default. - `hls` boolean — Enable HLS output. Enabled by default. - `hlsMpegTs` boolean — Enable HLS MPEG-TS output. Only available when enabled for your organization. - `vision` object, nullable — Vision configuration - `toneLut` object, nullable — Tone mapping LUT configuration - `saturationBoost` 'high' | 'low' | 'null', nullable — Saturation boost level - `strength` 'low' | 'medium' | 'high' | 'null', nullable — Tone mapping strength - `masteringDisplay` object, nullable — Mastering display configuration - `primaries` object, nullable — Mastering display color primaries - `type` 'rec2020' | 'p3d65' | 'rec709' | 'custom' | 'null', nullable — Color primaries preset - `red` object, nullable — Custom red primary coordinates (required when type is `custom`) - … - `green` object, nullable — Custom green primary coordinates (required when type is `custom`) - … - `blue` object, nullable — Custom blue primary coordinates (required when type is `custom`) - … - `whitePoint` object, nullable — Mastering display white point - `type` 'd65' | 'd60' | 'dci' | 'custom' | 'null', nullable — White point preset - `x` number, nullable — Custom white point x coordinate (required when type is `custom`) - `y` number, nullable — Custom white point y coordinate (required when type is `custom`) - `maxDisplayMasteringLuminance` number, nullable — Maximum display mastering luminance in nits (0-10000) - `minDisplayMasteringLuminance` number, nullable — Minimum display mastering luminance in nits - `contentLightLevels` object, nullable — Content light level configuration - `cllMode` 'auto' | 'expert' | 'null', nullable — Content light level mode. `expert` requires maxCll and maxFall (nits) - `maxCll` number, nullable — Maximum content light level in nits (required when cllMode is `expert`) - `maxFall` number, nullable — Maximum frame-average light level in nits (required when cllMode is `expert`) - `globalLook` object, nullable — Global look (L8) configuration - `l8Mode` 'off' | 'quickControls' | 'null', nullable — L8 global look mode - `l8ContrastBoost` 'off' | 'low' | 'mid' | 'high' | 'null', nullable — L8 contrast boost (required when l8Mode is `quickControls`) - `l8MidBoost` 'off' | 'low' | 'mid' | 'high' | 'null', nullable — L8 mid boost (required when l8Mode is `quickControls`) - `l8SaturationBoost` 'off' | 'low' | 'mid' | 'high' | 'null', nullable — L8 saturation boost (required when l8Mode is `quickControls`) - `contentType` object, nullable — Content type (L11) configuration - `l11ContentType` 'default' | 'cinema' | 'game' | 'sport' | 'ugc' | 'null', nullable — L11 content type - `l11WhitePointK` number, nullable — L11 white point in Kelvin, snapped to the 16 RPU steps - `atmos` object, nullable — Dolby Atmos configuration - `dialnorm` integer, required — Dolby Atmos dialnorm value. Must be an integer between -1 and -31. - `hasMore` boolean, required — Whether there are more than 10 engines - `link` string, required — Link to the full engines list - `count` number, required — Total number of engines - `distributions` IncludedDistributions — Included distributions preview - `data` Distribution[], required — First 10 distributions - `id` string, required — Unique identifier of the distribution - `createdAt` string, required — Creation timestamp - `name` string, required — Name of the distribution - `externalId` string — External identifier for the distribution - `enabled` boolean, required — Whether the distribution is enabled - `targetLatency` number — Deprecated: use latencies instead. - `latencies` object, required — Latency configuration per output protocol - `hesp` number, nullable — HESP latency in seconds (1-30, default: 2) - `hls` number, nullable — HLS latency in seconds (8-30, default: 10) - `security` object, required — Security configuration - `geoBlocking` object, required — Geo-blocking configuration - `enabled` boolean, required — Whether geo-blocking is enabled - `mode` 'allow' | 'deny', required — Geo-blocking mode - `countries` string[], required — List of country codes - `ipBlocking` object, required — IP blocking configuration - `enabled` boolean, required — Whether IP blocking is enabled - `mode` 'allow' | 'deny', required — IP blocking mode - `cidrs` string[], required — List of CIDR ranges - `refererBlocking` object — Referer blocking configuration - `enabled` boolean, required — Whether referer blocking is enabled - `allowedDomains` string[], required — List of allowed domains - `allowNativeApps` boolean, required — Whether native apps are allowed - `rewriteSegmentUrls` boolean — When enabled, a short-lived token is added to the segment URLs, derived from the token that was passed. This only works when JWT security is enabled on the same distribution. - `keys` object[], required — Security keys - `id` string, required — Security key ID - `name` string — Security key name - `endpoints` object, required — Endpoint configuration - `engineIds` string[], required — Connected engine IDs - `webRtc` object — WebRTC configuration - `priority` number, required — WebRTC priority - `src` object, required — WebRTC source configuration - `name` string, required — WebRTC source name - `accountId` string, required — WebRTC account ID - `apiUrl` string, required — WebRTC API URL - `maxBitrate` number — Maximum bitrate limit in bps - `outputs` object — Output format configuration - `hesp` boolean — Enable HESP output. Enabled by default. - `hls` boolean — Enable HLS output. Enabled by default. - `hlsMpegTs` boolean — Enable HLS MPEG-TS output. Disabled by default. - `dvr` object, required — DVR configuration - `enabled` boolean — Whether DVR is enabled on the distribution - `overrides` object[] — Distribution overrides - `deviceType` 'tv' | 'mobile' | 'desktop' | 'other' | 'null', nullable — Target device type - `sdkType` 'native' | 'web' | 'null', nullable — Target SDK type - `osName` 'apple' | 'android' | 'windows' | 'roku' | 'other' | 'null', nullable — Target OS name - `profileId` string, nullable — Target profile ID - `targets` object[], required — Override target distributions with weights - `distributionId` string, required — Target distribution ID - `weight` number, required — Weight (0-100) - `customEndpoints` object[] — Connected custom endpoints with weights - `customEndpointId` string, required — ID of the connected custom endpoint - `weight` number, required — Weight (0-100) - `ads` object — Ads configuration for the distribution - `dai` object — DAI endpoint settings - `weight` integer, required — Weight for DAI endpoints (0-100) - `priority` integer, required — Priority for DAI endpoints (any integer, lower = higher priority) - `hasMore` boolean, required — Whether there are more than 10 distributions - `link` string, required — Link to the full distributions list - `count` number, required — Total number of distributions --- [API](https://skmtc.net/dolby/apis/theolive-api.md) · [All operations](https://skmtc.net/dolby/apis/theolive-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dolby/theolive-api/versions/b57006d43141/schema)