Bitmovin Encodings API
The Encodings API from Bitmovin — 80 operation(s) for encodings.
The Encodings API from Bitmovin — 80 operation(s) for encodings.
openapi: 3.0.1
info:
title: Bitmovin Encoding Config Encodings API
description: REST API for cloud-based VOD and live video encoding. Supports H.264, H.265/HEVC, VP9, AV1 and more, along with adaptive bitrate packaging (HLS/DASH/Smooth Streaming), DRM (Widevine, PlayReady, FairPlay), and per-title encoding optimisation.
version: '3.0'
termsOfService: https://bitmovin.com
contact:
name: Bitmovin Inc
url: https://bitmovin.com
email: support@bitmovin.com
servers:
- url: https://api.bitmovin.com/v1
description: Bitmovin Server
variables: {}
security:
- ApiKeyAuth: []
- ApiKeyAuth: []
TenantOrgId: []
tags:
- name: Encodings
paths:
/encoding/encodings/{encoding_id}/streams/{stream_id}/qc/psnr:
post:
tags:
- Encodings
summary: PSNR quality metrics
description: Activates PSNR quality metrics for the selected stream
operationId: ActivatePsnrStreamQualityMetrics
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: stream_id
in: path
description: Id of the stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Audio Mix configuration
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}:
delete:
tags:
- Encodings
summary: Delete Encoding
operationId: DeleteEncodingEncodingsByEncodingId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the encoding
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/captions/scc/{captions_id}:
delete:
tags:
- Encodings
summary: Delete Convert SCC captions
operationId: DeleteEncodingEncodingsCaptionsSccByEncodingIdAndCaptionsId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: captions_id
in: path
description: Id of the caption.
style: simple
required: true
schema:
type: string
example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the caption
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/audio-mix/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete audio mix input stream
operationId: DeleteEncodingEncodingsInputStreamsAudioMixByEncodingIdAndAudioMixInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the audio mix input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the audio mix input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/captions/cea608/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete CEA 608 Input Stream
operationId: DeleteEncodingEncodingsInputStreamsCEA608ByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the CEA 608 input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the CEA 608 Input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/captions/cea708/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete CEA 708 Input Stream
operationId: DeleteEncodingEncodingsInputStreamsCEA708ByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the Encoding
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the CEA 708 input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the CEA 708 Input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/concatenation/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Concatenation Input Stream
operationId: DeleteEncodingEncodingsInputStreamsConcatenationByEncodingIdAndConcatenationInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the Concatenation input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Concatenation input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/dolby-atmos/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Dolby Atmos input stream
operationId: DeleteEncodingEncodingsInputStreamsDolbyAtmosByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the Dolby Atmos input stream
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Dolby Atmos input stream
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/dolby-vision/{dolby_vision_input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Dolby Vision input stream
operationId: DeleteEncodingEncodingsInputStreamsDolbyVisionByEncodingIdAndDolbyVisionInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: dolby_vision_input_stream_id
in: path
description: Id of the Dolby Vision input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Dolby Vision input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/sidecar/dolby-vision-metadata-ingest/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Dolby Vision Metadata Ingest Input Stream
operationId: DeleteEncodingEncodingsInputStreamsDolbyVisionMetadataIngestByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the Dolby Vision Metadata Ingest input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Dolby Vision Metadata Ingest input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/subtitles/dvb-subtitle/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete DVB Subtitle Input Stream
operationId: DeleteEncodingEncodingsInputStreamsDvbSubtitleByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the DVB Subtitle Input Stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the DVB Subtitle Input Stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/file/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete File stream
operationId: DeleteEncodingEncodingsInputStreamsFileByEncodingIdAndFileInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the File input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the File input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/ingest/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Ingest Input Stream
operationId: DeleteEncodingEncodingsInputStreamsIngestByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the ingest input stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the ingest input stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/trimming/h264-picture-timing/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete H264 Picture Timing Trimming Input Stream
operationId: DeleteEncodingEncodingsInputStreamsTrimmingH264PictureTimingByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the H264 Picture Timing Trimming Input Stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the H264 Picture Timing Trimming Input Stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/trimming/time-based/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Time-Based Trimming Input Stream
operationId: DeleteEncodingEncodingsInputStreamsTrimmingTimeBasedByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the Time-Based Trimming Input Stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Time-Based Trimming Input Stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/input-streams/trimming/timecode-track/{input_stream_id}:
delete:
tags:
- Encodings
summary: Delete Timecode Track Trimming Input Stream
operationId: DeleteEncodingEncodingsInputStreamsTrimmingTimecodeTrackByEncodingIdAndInputStreamId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: input_stream_id
in: path
description: Id of the Timecode Track Trimming Input Stream.
style: simple
required: true
schema:
type: string
example: a6336204-c929-4a61-b7a0-2cd6665114e9
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Timecode Track Trimming Input Stream
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/kantar-watermark:
delete:
tags:
- Encodings
summary: Delete the Kantar Watermark for an encoding
operationId: DeleteEncodingEncodingsKantarWatermarkByEncodingId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Kantar Watermark
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/keyframes/{keyframe_id}:
delete:
tags:
- Encodings
summary: Delete Keyframe
operationId: DeleteEncodingEncodingsKeyframesByEncodingIdAndKeyframeId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: keyframe_id
in: path
description: Id of the keyframe.
style: simple
required: true
schema:
type: string
example: e47151f2-cffb-4895-a3b9-0d4ed822705e
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the keyframe
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/muxings/broadcast-ts/{muxing_id}:
delete:
tags:
- Encodings
summary: Delete Broadcast TS muxing
operationId: DeleteEncodingEncodingsMuxingsBroadcastTsTsMuxingByEncodingIdAndMuxingId
parameters:
- name: encoding_id
in: path
description: ID of the Encoding.
style: simple
required: true
schema:
type: string
example: 63c7b1ff-a57e-435d-80cb-bcea7752bcd1
- name: muxing_id
in: path
description: ID of the Broadcast TS muxing
style: simple
required: true
schema:
type: string
example: 10fff470-813c-4cb7-963c-d020db4a7d83
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: ID of the Broadcast TS muxing
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/muxings/chunked-text/{muxing_id}:
delete:
tags:
- Encodings
summary: Delete Chunked Text muxing
operationId: DeleteEncodingEncodingsMuxingsChunkedTextByEncodingIdAndMuxingId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: muxing_id
in: path
description: Id of the Chunked Text muxing
style: simple
required: true
schema:
type: string
example: 5d8fb60a-8422-4d95-8157-b625413036de
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the Chunked Text muxing
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/muxings/cmaf/{muxing_id}:
delete:
tags:
- Encodings
summary: Delete CMAF muxing
operationId: DeleteEncodingEncodingsMuxingsCmafByEncodingIdAndMuxingId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: muxing_id
in: path
description: Id of the CMAF muxing
style: simple
required: true
schema:
type: string
example: 5d8fb60a-8422-4d95-8157-b625413036de
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the CMAF muxing
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}:
delete:
tags:
- Encodings
summary: Delete fMP4 muxing
operationId: DeleteEncodingEncodingsMuxingsFmp4ByEncodingIdAndMuxingId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
example: f3177c2e-0000-4ba6-bd20-1dee353d8a72
- name: muxing_id
in: path
description: Id of the fMP4 muxing
style: simple
required: true
schema:
type: string
example: 5d8fb60a-8422-4d95-8157-b625413036de
responses:
'200':
description: Successful response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
data:
properties:
result:
allOf:
- $ref: '#/components/schemas/BitmovinResponse'
- description: Id of the fMP4 muxing
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/aes/{drm_id}:
delete:
tags:
- Encodings
summary: Delete AES encryption configuration from an fMP4 muxing
operationId: DeleteEncodingEncodingsMuxingsFmp4DrmAesByEncodingIdAndMuxingIdAndDrmId
parameters:
- name: encoding_id
in: path
description: Id of the encoding.
style: simple
required: true
schema:
type: string
exam
# --- truncated at 32 KB (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitmovin/refs/heads/main/openapi/bitmovin-encodings-api-openapi.yml