--- title: "Create an engine for a channel" method: POST path: "/channels/{id}/engines" tags: ["Channels", "Engines"] --- # Create an engine for a channel `POST /channels/{id}/engines` ## Path parameters - `id` string, required — Channel ID ## Request body - object - `ingestId` string — Ingest ID to connect the engine to - `name` string, required — Name of the engine - `region` string, required — Region ID to deploy the engine in - `priority` number — Engine priority (-100 to 100). Lower numbers mean higher priority - `drm` boolean — Enable DRM. Only possible when enabled for your organization. - `quality` object, required — Quality configuration - `abrLadderId` string, required — ABR ladder ID - `daiAssetKey` string, nullable — DAI asset key - `overlays` object[] — 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) - `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. Only available when enabled for your organization. - `vision` object, nullable — Vision configuration. Only available when enabled for your organization. Pass `null` to disable. - `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`) - `x` number, required — Chromaticity x coordinate - `y` number, required — Chromaticity y coordinate - `green` object, nullable — Custom green primary coordinates (required when type is `custom`) - `x` number, required — Chromaticity x coordinate - `y` number, required — Chromaticity y coordinate - `blue` object, nullable — Custom blue primary coordinates (required when type is `custom`) - `x` number, required — Chromaticity x coordinate - `y` number, required — Chromaticity y coordinate - `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. Only available when the connected ABR ladder has Dolby Atmos audio configured. Pass `null` to disable. - `dialnorm` integer, nullable, required — Dolby Atmos dialnorm value. Must be an integer between -1 and -31. Pass `null` to unset it. ## Response `200` Engine created - EngineObjectResult - `data` object, required — Engine object - `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`) - `x` number, required — Chromaticity x coordinate - `y` number, required — Chromaticity y coordinate - `green` object, nullable — Custom green primary coordinates (required when type is `custom`) - `x` number, required — Chromaticity x coordinate - `y` number, required — Chromaticity y coordinate - `blue` object, nullable — Custom blue primary coordinates (required when type is `custom`) - `x` number, required — Chromaticity x coordinate - `y` number, required — Chromaticity y coordinate - `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. --- [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)