Retrieve an image | Documentation

Path parameters

space_idstringRequired

Alphanumeric id of the space to retrieve.

asset_idstringRequired

Alphanumeric id of the asset to which the image belongs.

unique_idstringRequired

Alphanumeric unique id identifying the image.

namestringRequired

The original file name of the image.

Query parameters

wdoubleOptional

The desired width of the image in pixels (cannot be zero).

hdoubleOptional

The desired height of the image in pixels (cannot be zero).

fmenumOptional

The desired image output format. The default is the original image format.

flenumOptional

For JPEG images, you can request a progressive JPEG. Should be used in conjunction with the fm parameter set to jpg. For PNG images, you can request a 8-bit PNG. Should be used in conjunction with the fm parameter set to png.

Allowed values:

fitenumOptional

By default, images are resized to fit into the specified dimensions, only if the original asset is larger than the specified limit (width and height). The image will take up the maximum space within the bounding box that was provided, at its original aspect ratio. You can request a different behavior using the fit parameter.

Allowed values:

fenumOptional

You can choose the focus area for resizing when using fit type pad, fill, crop or thumb. Focus area has no effect on the default or scale fit type. The default is center.

rstringOptional

You can add rounded corners to your image or crop to a circle/ellipse. The default is 0.

Possible values:

The size of the corner radius in pixels (e.g., “20”)
“max” keyword for a full circle/ellipse

You can add rounded corners to your image or crop to a circle/ellipse. The default is 0. Possible values: - The size of the corner radius in pixels (e.g., "20") - "max" keyword for a full circle/ellipse

qdoubleOptional

Quality as a percentage, between 1 and 100.

colorstringOptional

A color constant.

Response headers

Content-TypestringOptional

Content-Type

Response

OK - Request successful