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

# Get an ingest by ID

`GET /ingests/{id}`

## Path parameters

- `id` string, required — Ingest ID

## Response `200`

The requested 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-04** `b57006d43141` — 1 info
  - 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` — 1 info
  - 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` — 1 info
  - 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/get.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)