---
title: "Create an ingest for a channel"
method: POST
path: "/channels/{id}/ingests"
tags: ["Channels", "Ingests"]
---

# Create an ingest for a channel

`POST /channels/{id}/ingests`

## Path parameters

- `id` string, required — Channel ID

## Request body

- CreateIngestBody
  - `name` string, required — Name of the ingest
  - `type` 'rtmp-push' | 'rtmp-pull' | 'srt-pull' | 'srt-push' | 'sdi-pull' | 'rtsp-pull' | 'ndi-pull', required — Ingest type. Note: srt-push requires SRT push to be enabled at organization level
  - `url` string — Source URL (required for pull types, except sdi-pull and ndi-pull). Must start with "rtsp://" for rtsp-pull
  - `region` string — Region ID (required for rtmp-push, srt-pull and rtmp-pull). Must be a single ingest enabled region for pull types. Required and must be a DUPLO region when a 'speech' enhancement is enabled. Required and must be an on-prem region for rtsp-pull, ndi-pull and sdi-pull (ndi-pull and sdi-pull additionally require the region to support the ingest type)
  - `captions` object[] — Caption configuration
    - `channel` number, required — Caption channel number
    - `language` string, required — Caption language code
    - `label` string — Caption label
  - `tracks` object — 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
  - `sdi` object — SDI capture card configuration (required for sdi-pull)
    - `persistentId` string — Persistent ID of the SDI capture card, identifying it across reboots. Required for sdi-pull ingests: it must match an available SDI device of the region (see `/regions/{regionId}/sdi`) that is not connected to another ingest
    - `audioConnection` 'auto' | 'sdi' | 'hdmi' | 'optical-sdi' | 'component' | 'composite' | 'svideo' — Audio connection type
    - `videoConnection` 'auto' | 'sdi' | 'hdmi' | 'optical-sdi' | 'component' | 'composite' | 'svideo' — Video connection type
    - `videoMode` 'auto' | 'ntsc' | 'ntsc2398' | 'pal' | 'ntsc-p' | 'pal-p' | '1080p2398' | '1080p24' | '1080p25' | '1080p2997' | '1080p30' | '1080i50' | '1080i5994' | '1080i60' | '1080p50' | '1080p5994' | '1080p60' | '720p50' | '720p5994' | '720p60' | '1556p2398' | '1556p24' | '1556p25' | '2kdcip2398' | '2kdcip24' | '2kdcip25' | '2kdcip2997' | '2kdcip30' | '2kdcip50' | '2kdcip5994' | '2kdcip60' | '2160p2398' | '2160p24' | '2160p25' | '2160p2997' | '2160p30' | '2160p50' | '2160p5994' | '2160p60' | 'ntsc-widescreen' | 'ntsc2398-widescreen' | 'pal-widescreen' | 'ntsc-p-widescreen' | 'pal-p-widescreen' | '4kdcip2398' | '4kdcip24' | '4kdcip25' | '4kdcip2997' | '4kdcip30' | '4kdcip50' | '4kdcip5994' | '4kdcip60' | '8kp2398' | '8kp24' | '8kp25' | '8kp2997' | '8kp30' | '8kp50' | '8kp5994' | '8kp60' | '8kdcip2398' | '8kdcip24' | '8kdcip25' | '8kdcip2997' | '8kdcip30' | '8kdcip50' | '8kdcip5994' | '8kdcip60' — Video mode
    - `profile` 'default' | 'one-sub-device-full' | 'one-sub-device-half' | 'two-sub-devices-full' | 'two-sub-devices-half' | 'four-sub-devices-half' — SDI profile
    - `videoFormat` 'auto' | '8bit-yuv' | '10bit-yuv' | '8bit-argb' | '8bit-bgra' | '10bit-rgb' — Video format
  - `ndi` object — NDI source configuration (required for ndi-pull)
    - `id` string, required — ID of the NDI source. Required for ndi-pull ingests: it must match a non-stale NDI source of the region (see `/regions/{regionId}/ndi`) that is not connected to another ingest

## Response `200`

Ingest created

- IngestObjectResult
  - `data` object, required — Ingest object
    - `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' | 'rtsp-pull' | 'ndi-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
    - `sdi` IngestSdi — SDI capture card configuration (only for sdi-pull ingests)
      - `persistentId` string — Persistent ID of the SDI capture card, identifying it across reboots. Required for sdi-pull ingests: it must match an available SDI device of the region (see `/regions/{regionId}/sdi`) that is not connected to another ingest
      - `audioConnection` 'auto' | 'sdi' | 'hdmi' | 'optical-sdi' | 'component' | 'composite' | 'svideo' — Audio connection type
      - `videoConnection` 'auto' | 'sdi' | 'hdmi' | 'optical-sdi' | 'component' | 'composite' | 'svideo' — Video connection type
      - `videoMode` 'auto' | 'ntsc' | 'ntsc2398' | 'pal' | 'ntsc-p' | 'pal-p' | '1080p2398' | '1080p24' | '1080p25' | '1080p2997' | '1080p30' | '1080i50' | '1080i5994' | '1080i60' | '1080p50' | '1080p5994' | '1080p60' | '720p50' | '720p5994' | '720p60' | '1556p2398' | '1556p24' | '1556p25' | '2kdcip2398' | '2kdcip24' | '2kdcip25' | '2kdcip2997' | '2kdcip30' | '2kdcip50' | '2kdcip5994' | '2kdcip60' | '2160p2398' | '2160p24' | '2160p25' | '2160p2997' | '2160p30' | '2160p50' | '2160p5994' | '2160p60' | 'ntsc-widescreen' | 'ntsc2398-widescreen' | 'pal-widescreen' | 'ntsc-p-widescreen' | 'pal-p-widescreen' | '4kdcip2398' | '4kdcip24' | '4kdcip25' | '4kdcip2997' | '4kdcip30' | '4kdcip50' | '4kdcip5994' | '4kdcip60' | '8kp2398' | '8kp24' | '8kp25' | '8kp2997' | '8kp30' | '8kp50' | '8kp5994' | '8kp60' | '8kdcip2398' | '8kdcip24' | '8kdcip25' | '8kdcip2997' | '8kdcip30' | '8kdcip50' | '8kdcip5994' | '8kdcip60' — Video mode
      - `profile` 'default' | 'one-sub-device-full' | 'one-sub-device-half' | 'two-sub-devices-full' | 'two-sub-devices-half' | 'four-sub-devices-half' — SDI profile
      - `videoFormat` 'auto' | '8bit-yuv' | '10bit-yuv' | '8bit-argb' | '8bit-bgra' | '10bit-rgb' — Video format
    - `ndi` IngestNdi — NDI source configuration (only for ndi-pull ingests)
      - `id` string, required — ID of the NDI source. Required for ndi-pull ingests: it must match a non-stale NDI source of the region (see `/regions/{regionId}/ndi`) that is not connected to another ingest

---

[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/revisions/3dc30dd23624/schema)