DocsAPI referenceOperations

List presets

Every preset with its type, its full options as an output object and whether it is deprecated. During the preview, preset options may change; the API changelog lists every change.

GET /v1/presets

Needs an API key: Authorization: Bearer $VIDEXO_API_KEY.

Request

bash

curl "$VIDEXO_API_URL/v1/presets" \
  -H "Authorization: Bearer $VIDEXO_API_KEY"

JavaScript

const response = await fetch(`${process.env.VIDEXO_API_URL}/v1/presets`, {
  headers: { Authorization: `Bearer ${process.env.VIDEXO_API_KEY}` },
});
const presets = await response.json();

Response

200 JSON

{
  "data": [
    {
      "name": "web-720p",
      "type": "video",
      "description": "MP4 for the web: H.264 at CRF 23 within 1280 by 720 (never enlarged), AAC 128k, fast start.",
      "deprecated": false,
      "output": {
        "format": "mp4",
        "resize": {
          "width": 1280,
          "height": 720,
          "fit": "contain",
          "enlarge": false
        },
        "video": {
          "codec": "h264",
          "crf": 23,
          "encoder_preset": "veryfast",
          "pixel_format": "yuv420p",
          "faststart": true
        },
        "audio": {
          "codec": "aac",
          "bitrate": "128k"
        }
      }
    },
    {
      "name": "web-1080p",
      "type": "video",
      "description": "MP4 for the web: H.264 at CRF 22 within 1920 by 1080 (never enlarged), AAC 160k, fast start.",
      "deprecated": false,
      "output": {
        "format": "mp4",
        "resize": {
          "width": 1920,
          "height": 1080,
          "fit": "contain",
          "enlarge": false
        },
        "video": {
          "codec": "h264",
          "crf": 22,
          "encoder_preset": "veryfast",
          "pixel_format": "yuv420p",
          "faststart": true
        },
        "audio": {
          "codec": "aac",
          "bitrate": "160k"
        }
      }
    },
    {
      "name": "social-vertical",
      "type": "video",
      "description": "Vertical 1080 by 1920 MP4, cropped at the centre, 30 fps, keeping the sound when there is one.",
      "deprecated": false,
      "output": {
        "format": "mp4",
        "resize": {
          "width": 1080,
          "height": 1920,
          "fit": "cover",
          "anchor": "center"
        },
        "fps": 30,
        "video": {
          "codec": "h264",
          "crf": 23,
          "encoder_preset": "veryfast",
          "pixel_format": "yuv420p",
          "faststart": true
        },
        "audio": {
          "codec": "aac",
          "bitrate": "128k"
        }
      }
    },
    {
      "name": "square",
      "type": "video",
      "description": "Square 1080 by 1080 MP4, cropped at the centre, 30 fps, keeping the sound when there is one.",
      "deprecated": false,
      "output": {
        "format": "mp4",
        "resize": {
          "width": 1080,
          "height": 1080,
          "fit": "cover",
          "anchor": "center"
        },
        "fps": 30,
        "video": {
          "codec": "h264",
          "crf": 23,
          "encoder_preset": "veryfast",
          "pixel_format": "yuv420p",
          "faststart": true
        },
        "audio": {
          "codec": "aac",
          "bitrate": "128k"
        }
      }
    },
    {
      "name": "podcast-audio",
      "type": "audio",
      "description": "MP3 128k stereo at 44.1 kHz, normalised to -16 LUFS with peaks under -1.5 dBTP.",
      "deprecated": false,
      "output": {
        "format": "mp3",
        "audio": {
          "codec": "mp3",
          "bitrate": "128k",
          "sample_rate": 44100,
          "channels": 2,
          "normalize": {
            "loudness": -16,
            "true_peak": -1.5,
            "range": 11
          }
        }
      }
    },
    {
      "name": "gif-preview",
      "type": "gif",
      "description": "An animated GIF at most 480 pixels wide at 12 fps with 256 colours: the first 5 seconds unless trim says otherwise.",
      "deprecated": false,
      "output": {
        "format": "gif",
        "trim": {
          "start": 0,
          "duration": 5
        },
        "resize": {
          "width": 480,
          "enlarge": false
        },
        "fps": 12,
        "colors": 256
      }
    },
    {
      "name": "poster",
      "type": "image",
      "description": "A JPEG within 1280 by 720 (never enlarged) of the most representative of the first frames, or of the frame at `at`.",
      "deprecated": false,
      "output": {
        "format": "jpg",
        "resize": {
          "width": 1280,
          "height": 720,
          "fit": "contain",
          "enlarge": false
        },
        "at": "auto",
        "quality": "high"
      }
    }
  ]
}

Responses

Responses
Status	Body	When
200	PresetList	The presets.
401	Problem	authentication_failed (missing_api_key, invalid_api_key, api_key_revoked, api_key_expired)
403	Problem	permission_denied (token_scope): a client token cannot call this route
429	Problem	rate_limited, with Retry-After in seconds