Transcode Preset

Returns detailed information about a specific transcoding preset.

Request

Property	Value
Method	`GET`
URL	`/api/transcode/settings/presets/{presetId}`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/transcode/settings/presets/{presetId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`presetId`	integer	Yes	Unique identifier of the preset

Request

bash

curl -X GET "{BASE_URL}/api/transcode/settings/presets/{presetId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Preset Object

Parameter	Type	Description
`data.id`	integer	Unique identifier of the preset
`data.attributes.name.value`	string	Preset name
`data.attributes.name.editable`	boolean	Indicates if the field can be modified
`data.attributes.suffix.value`	string	Stream key suffix for transcoded output
`data.attributes.suffix.editable`	boolean	Indicates if the field can be modified

Video Settings

Parameter	Type	Description
`data.attributes.video.encoder.value`	string	Video encoder
`data.attributes.video.encoder.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.width.value`	integer \| null	Output video width
`data.attributes.video.width.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.height.value`	integer \| null	Output video height
`data.attributes.video.height.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.bitrate.value`	integer	Video bitrate in kbps
`data.attributes.video.bitrate.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.frameRate.value`	integer	Output frame rate
`data.attributes.video.frameRate.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.keyFrameInterval.value`	integer	Keyframe interval in frames
`data.attributes.video.keyFrameInterval.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.profile.value`	string	H.264 profile
`data.attributes.video.profile.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.preset.value`	string	Encoder preset
`data.attributes.video.preset.editable`	boolean	Indicates if the field can be modified
`data.attributes.video.tune.value`	string	Encoder tuning
`data.attributes.video.tune.editable`	boolean	Indicates if the field can be modified

Audio Settings

Parameter	Type	Description
`data.attributes.audio.encoder.value`	string	Audio encoder
`data.attributes.audio.encoder.editable`	boolean	Indicates if the field can be modified
`data.attributes.audio.codec.value`	string	Audio codec
`data.attributes.audio.codec.editable`	boolean	Indicates if the field can be modified
`data.attributes.audio.bitrate.value`	integer	Audio bitrate in kbps
`data.attributes.audio.bitrate.editable`	boolean	Indicates if the field can be modified
`data.attributes.audio.sampleRate.value`	integer	Audio sample rate in Hz
`data.attributes.audio.sampleRate.editable`	boolean	Indicates if the field can be modified
`data.attributes.audio.channels.value`	integer	Number of audio channels
`data.attributes.audio.channels.editable`	boolean	Indicates if the field can be modified

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "id": 0,
    "attributes": {
      "name": {
        "editable": true,
        "value": "360p"
      },
      "suffix": {
        "editable": true,
        "value": "_360p"
      },
      "video": {
        "encoder": {
          "editable": false,
          "value": "libx264"
        },
        "width": {
          "editable": true,
          "value": null
        },
        "height": {
          "editable": true,
          "value": 360
        },
        "bitrate": {
          "editable": true,
          "value": 2500
        },
        "frameRate": {
          "editable": true,
          "value": 30
        },
        "keyFrameInterval": {
          "editable": true,
          "value": 30
        },
        "profile": {
          "editable": true,
          "value": "high"
        },
        "preset": {
          "editable": true,
          "value": "ultrafast"
        },
        "tune": {
          "editable": true,
          "value": "zerolatency"
        }
      },
      "audio": {
        "encoder": {
          "editable": false,
          "value": "copy"
        },
        "codec": {
          "editable": false,
          "value": "UNKNOWN"
        }
      }
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1765795640170
  }
}

Error Responses

Preset Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Transcode Preset Entity not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.