Skip to main content

Media Delivery API reference guide

The Media Delivery API manipulates images, retrieves sets, and serves video via query parameters appended to Dynamic Media URLs, applied on the fly at delivery time. This quick reference lists every parameter and links to interactive examples.

This page provides a quick reference followed by every parameter with interactive examples, split into sections.

Every parameter can be appended to an asset's URL as a query string:

Base URL pattern

https://cdn.media.amplience.net/{type}/{account}/{assetName}?{parameters}
Tip

type identifies the asset kind (i for images, s for sets, v for video). See URL structure in the overview for the full breakdown.

Here's a simple example - rotate an image by 90°:

https://cdn.media.amplience.net/i/ampproduct/two-friends-on-deck?rotate=90
Try it...
90

In this guide
Link copied!

Parameters for resizing, cropping, converting and adjusting images, grouped by task below.

Sizing and scaling
Link copied!

Resize with w, h, maxW, and maxH, then control what happens when the image does not fit the requested dimensions with scale modes, point of interest, and upscaling.

Sizing · w · h · maxW · maxH · Scale mode · sm · sm=edge · sm=clamp · scaleFit · poi · filter · upscale

Cropping and rotation
Link copied!

Crop a region or trim from the edges, before or after resizing, then rotate or flip.

crop · ecrop · pcrop · pecrop · rotate · protate · flip

Format and quality
Link copied!

Choose the output format, including automatic format selection, and tune compression globally, per format, or from platform defaults.

qlt · fmt · fmt=auto · qlt=default · Per-format quality parameters · dpi · dpiFilter · strip · fmt.jpeg.chroma · fmt.jpeg.interlaced · PNG output options

Image adjustments
Link copied!

Colour space, sharpening, composite modes, background colour, blur, noise reduction, gamma, hue, saturation, and brightness.

cs · unsharp · cm · cm=copy · bg · blur · noiser · gamma · hue, sat, bri

Layers and text
Link copied!

Composite images and text onto a base image, and control their position, anchor, opacity, and visibility.

Layers · src · top, left, bottom, right · anchor · opacity · visible · canvas · Text layers

Metadata
Link copied!

Return an asset's metadata instead of the asset, filter which fields come back, and reference metadata values inside a query.

metadata=true · metaFilter · Referencing metadata in queries

Variables and conditionals
Link copied!

Build queries that adapt at request time using variables, conditionals, expressions, and a fallback image for missing assets.

img404 · ${variable} · Conditionals · Expressions

Sets
Link copied!

Return individual images from a set, retrieve set metadata in five formats, and use SEO-friendly set URLs.

Retrieving set images · Return first element · Return nth element · Return nested nth element · Set metadata · JSONP format · JSON format · XML format · Text format · HTML format · SEO and sets

Video
Link copied!

Request a transcode profile, generate thumbnails from a video, retrieve video metadata, and build HTML video embeds.

Serving video over HTTPS · Video thumbnails · Return poster frame · Return specified thumbnail · Video metadata · JSONP format · JSON format · XML format · Text format · Sitemap · Generating HTML video embeds

SEO
Link copied!

SEO-friendly path segments can be appended to image URLs to improve search engine indexing.

Accelerated Media
Link copied!

Accelerated Media is an optional add-on that unlocks the following features:

  • Amplience Smart Images - automatic format selection via fmt=auto
  • AVIF format - next-generation image compression
  • VP9 and HEVC video codecs

To enable Accelerated Media on your account, contact your Account Manager.