Presets Resource

Description

The Presets endpoint allows you to manage video and audio encoding presets. You can create, update, delete, and retrieve presets.

A preset is a reusable combination of an audio codec (plus its maximum limits as capabilities), a video codec (plus its maximum limits as capabilities), a container format, video/audio settings (resizing, cropping, resampling, etc.) as well as thumbnail and logo settings. When submitting a job to the Jobs resource, each output must reference a preset by its ID. Alternatively, you can browse and manage presets in the "Presets" tab of the MediaHub web UI.

There are two kinds of presets:

• System presets: Pre-defined presets provided by us. They are automatically granted to every new user account and can be viewed without an OAuth token. System presets cannot be modified or deleted.
• Custom presets: Created by you from scratch, e.g. via the API described here or using the "Presets" tab in the web UI.

Endpoints

• GET /presets: List all presets or get a specific preset by ID
• POST /presets: Create a new preset
• PUT /presets/ID: Update an existing preset
• DELETE /presets/ID: Delete a preset

Authentication

A Bearer token is required for all endpoints that access your custom presets. System presets can be viewed without authentication.

Supported Methods

• GET: Retrieve information about presets
• POST: Create a new preset
• PUT: Update an existing preset
• DELETE: Delete a preset

Request Headers

• Authorization: Bearer [AUTH_TOKEN]
• Content-Type: application/json (for POST and PUT requests)

Common Parameters

• format: string (Optional)
  Values: json, xml
  Overrides the Request Accept header.
• human: boolean (Optional)
  Values: true, false
  If 'true', the response will be in a structured, more human-readable form.
• show_null: boolean (Optional)
  Values: true, false
  If set to "true", the response will contain also keys that are not set to a value.
• expand_all: boolean (Optional)
  Values: true, false
  Recursively look up referenced objects and embed the respective JSON as nested objects directly into the response.

For detailed information about each method, please refer to the respective documentation files: GET.md, POST.md, PUT.md and DELETE.md.