List Quality Goal presets and slider axes

GET

/goals/presets

const url = 'https://example.com/api/v1/goals/presets?arrType=radarr';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/goals/presets?arrType=radarr'

Returns the built-in goal presets, the slider-axis metadata, and the engine version. The editor renders sliders and can run the pure engine client-side from this payload with nothing hardcoded. arrType=lidarr scopes the response to the audio presets and hides the video-only hdrPreference/resolutionCeiling axes; omitting it (or radarr/sonarr) returns the video presets.

Parameters

Query Parameters

arrType

string

Allowed values: radarr sonarr lidarr

Responses

200

Presets and axes

application/json

object

presets

required

Array<object>

object

required

string

Allowed values: best-quality smallest-size balanced 4k-hdr-priority audio-lossless-priority audio-balanced audio-space-saver

label

required

string

description

required

string

weights

required

object

qualityVsSize

required

integer

<= 100

compatibility

required

integer

<= 100

hdrPreference

required

integer

<= 100

unwantedStrictness

required

integer

<= 100

resolutionCeiling

required

string

Allowed values: 720p 1080p 2160p

axes

required

Array<object>

object

key

required

string

label

required

string

kind

required

string

Allowed values: weight strictness ceiling

min

integer

max

integer

step

integer

options

Array<string>

Allowed values: 720p 1080p 2160p

description

required

string

engineVersion

required

string

Example

{
  "presets": [
    {
      "id": "best-quality",
      "weights": {
        "resolutionCeiling": "720p"
      }
    }
  ],
  "axes": [
    {
      "kind": "weight",
      "options": [
        "720p"
      ]
    }
  ]
}