---
title: "Update an ingest by ID"
method: PATCH
path: "/ingests/{id}"
tags: ["Ingests"]
---

# Update an ingest by ID

`PATCH /ingests/{id}`

## Path parameters

- `id` string, required — Ingest ID

## Request body

- UpdateIngestBody
  - `name` string — Name of the ingest
  - `type` 'rtmp-push' | 'rtmp-pull' | 'srt-pull' | 'srt-push' | 'sdi-pull' — Ingest type. Note: srt-push requires SRT push to be enabled at organization level
  - `url` string — Source URL
  - `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
  - `captions` object[] — Caption configuration (replaces the whole list)
    - `channel` number, required — Caption channel number
    - `language` string, required — Caption language code
    - `label` string — Caption label
  - `enhancements` SpeechEnhancement[] — Enhancement configuration (replaces the whole list). At most 1 'speech' entry is allowed. A 'speech' entry requires the ingest to have a DUPLO region
    - `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. Margins in percent of viewport height
      - `bottom` integer — Margin from the bottom in percent of viewport height
  - `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 configuration
    - `persistentId` number, required — Persistent ID of the SDI device
    - `deviceNumber` number, required — Device number
    - `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

## Response `200`

Updated ingest

- 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', 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. Margins in percent of viewport height
        - `bottom` integer — Margin from the bottom in percent of viewport height

## Changes

- **2026-08-13** `6b4e32dfe4d1` — 1 warning
  - the `enhancements/items/oneOf[#/components/schemas/SpeechEnhancement]/position/bottom` request property's max was set to `90.00`
- **2026-08-04** `b57006d43141` — 2 info
  - added the new optional request property `enhancements/items/oneOf[#/components/schemas/SpeechEnhancement]/extraPrompt`
  - added the optional property `data/allOf[#/components/schemas/Ingest]/enhancements/items/oneOf[#/components/schemas/SpeechEnhancement]/extraPrompt` to the response with the `200` status
- **2026-07-31** `e289c4e46b97` — 2 info
  - added the new optional request property `enhancements/items/oneOf[#/components/schemas/SpeechEnhancement]/latencyMode`
  - added the optional property `data/allOf[#/components/schemas/Ingest]/enhancements/items/oneOf[#/components/schemas/SpeechEnhancement]/latencyMode` to the response with the `200` status
- **2026-07-26** `7bfe58df4d98` — 2 info
  - added the new optional request property `enhancements`
  - added the optional property `data/allOf[#/components/schemas/Ingest]/enhancements` to the response with the `200` status

[Change history](https://skmtc.dev/dolby/apis/theolive-api/changes/ingests/:id/patch.md)

---

[API](https://skmtc.dev/dolby/apis/theolive-api.md) · [All operations](https://skmtc.dev/dolby/apis/theolive-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dolby/theolive-api/revisions/6b4e32dfe4d1/schema)