Preset List

Returns a list of transcoding presets.

Request

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

Request

bash

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

Response Body

Preset List

Parameter	Type	Description
`data.list`	array	Array of preset objects

Preset Object

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

Video Settings

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

Audio Settings

Parameter	Type	Description
`data.list[].attributes.audio.encoder.value`	string	Audio encoder
`data.list[].attributes.audio.encoder.editable`	boolean	Indicates if the field can be modified
`data.list[].attributes.audio.codec.value`	string	Audio codec
`data.list[].attributes.audio.codec.editable`	boolean	Indicates if the field can be modified
`data.list[].attributes.audio.bitrate.value`	integer	Audio bitrate in kbps
`data.list[].attributes.audio.bitrate.editable`	boolean	Indicates if the field can be modified
`data.list[].attributes.audio.sampleRate.value`	integer	Audio sample rate in Hz
`data.list[].attributes.audio.sampleRate.editable`	boolean	Indicates if the field can be modified
`data.list[].attributes.audio.channels.value`	integer	Number of audio channels
`data.list[].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": {
    "list": [
      {
        "id": 1,
        "attributes": {
          "name": {
            "editable": true,
            "value": "720p"
          },
          "suffix": {
            "editable": true,
            "value": "_720p"
          },
          "video": {
            "encoder": {
              "editable": false,
              "value": "libx264"
            },
            "width": {
              "editable": true,
              "value": null
            },
            "height": {
              "editable": true,
              "value": 720
            },
            "bitrate": {
              "editable": true,
              "value": 3500
            },
            "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": "aac"
            },
            "codec": {
              "editable": false,
              "value": "AAC"
            },
            "bitrate": {
              "editable": true,
              "value": 150
            },
            "sampleRate": {
              "editable": true,
              "value": 48000
            },
            "channels": {
              "editable": true,
              "value": 2
            }
          }
        }
      }
    ]
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1765795365196
  }
}

Error Response (4xx/5xx)

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

json

{
  "message": "Error message"
}

Support Needed?

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