Sign in
Channels
Ingests

Create an ingest for a channel

post/channels/{id}/ingests

Path parameters

idstring required

Channel ID

Channel ID

Request body

namestring 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

urlstring

Source URL (required for pull types, except sdi-pull and ndi-pull). Must start with "rtsp://" for rtsp-pull

regionstring

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)

Response

Ingest created

Changes

Changed in 5 of the 9 revisions of this API.612

  • 3dc30dd2362446See the full diff
    • ●

      removed the request property enhancements

      request-property-removed

    • ●

      removed the optional property data/allOf[Ingest]/enhancements from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new ndi-pull enum value to the data/allOf[Ingest]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new rtsp-pull enum value to the data/allOf[Ingest]/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property ndi

      new-optional-request-property

    • ○

      added the new optional request property sdi

      new-optional-request-property

    • ○

      added the new ndi-pull enum value to the request property type

      request-property-enum-value-added

    • ○

      added the new rtsp-pull enum value to the request property type

      request-property-enum-value-added

    • ○

      added the optional property data/allOf[Ingest]/ndi to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Ingest]/sdi to the response with the 200 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6b4e32dfe4d11See the full diff
    • ●

      the enhancements/items/oneOf[SpeechEnhancement]/position/bottom request property's max was set to 90.00

      request-property-max-set

  • b57006d431412See the full diff
    • ○

      added the new optional request property enhancements/items/oneOf[SpeechEnhancement]/extraPrompt

      new-optional-request-property

    • ○

      added the optional property data/allOf[Ingest]/enhancements/items/oneOf[SpeechEnhancement]/extraPrompt to the response with the 200 status

      response-optional-property-added

  • e289c4e46b972See the full diff
    • ○

      added the new optional request property enhancements/items/oneOf[SpeechEnhancement]/latencyMode

      new-optional-request-property

    • ○

      added the optional property data/allOf[Ingest]/enhancements/items/oneOf[SpeechEnhancement]/latencyMode to the response with the 200 status

      response-optional-property-added

  • 7bfe58df4d9812See the full diff
    • ●

      removed the request property translations

      request-property-removed

    • ○

      added the new optional request property enhancements

      new-optional-request-property

    • ○

      added the optional property data/allOf[Ingest]/enhancements to the response with the 200 status

      response-optional-property-added