v1

latestOpenAPI 3.0.02026-08-06194226589.8 KB

Assets

Get the asset content.

get/api/assets/{app}/{idOrSlug}/{more}

Path parameters

appstring required

The name of the app.

idOrSlugstring required

The id or slug of the asset.

morestring required

Optional suffix that can be used to seo-optimize the link to the image Has not effect.

Query parameters

versioninteger

The optional version of the asset.

cacheinteger

The cache duration in seconds.

downloadinteger

Set it to 0 to prevent download.

widthinteger nullable

The target width of the asset, if it is an image.

heightinteger nullable

The target height of the asset, if it is an image.

qualityinteger nullable

Optional image quality, it is is an jpeg image.

mode'Crop' | 'CropUpsize' | 'Pad' | 'BoxPad' | 'Max' | 'Min' | 'Stretch'

The resize mode when the width and height is defined.

bgstring nullable

Optional background color.

focusXnumber float nullable

Override the y focus point.

focusYnumber float nullable

Override the x focus point.

nofocusboolean

True to ignore the asset focus point if any.

autoboolean

True to use auto format.

forceboolean

True to force a new resize even if it already stored.

deletedboolean

Also return deleted content items.

format'AVIF' | 'BMP' | 'GIF' | 'JPEG' | 'PNG' | 'TGA' | 'TIFF' | 'WEBP'

True to force a new resize even if it already stored.

watermarkUrlstring nullable

Adds the image with the given URL on to of your image. If the watermark cannot be loaded or found, the watermark is just ignored.

watermarkOpacitynumber float

The opacity of the watermark image.

watermarkAnchor'TopLeft' | 'TopRight' | 'BottomLeft' | 'BottomRight' | 'Center'

The anchor where the watermark should be placed.

Response

Asset found and content or (resized) image returned.