Sign in
Images

Render an image

get/v1/image/{id}

Path parameters

idstring required

Query parameters

widthinteger nullable

Width to resize the rendered image

heightinteger nullable

Height to resize the rendered image

dpiinteger nullable

DPI to specify in rendered image's metadata.

dl'1' | '0' nullable

Add this to cause the rendered image to be downloaded as a file instead of being displayed

aspect_ratiostring nullable

Define an aspect ratio to crop the rendered image to. Specify the value as x_y. When using aspect_ratio, you must include one of: [x_1 & x_2], [y_1 & y_2], [x_1 & crop_width], [y_1 & crop_height], [crop_width] or [crop_height].

x_originstring nullable

Define the origin for cropping along the x axis. When using aspect_ratio, you can only specify one of x_origin or y_origin.

y_originstring nullable

Define the origin for cropping along the y axis. When using aspect_ratio, you can only specify one of x_origin or y_origin.

x_1string nullable

Define the x_1 position for cropping. You can specify either x_1 & x_2 or x_1 and crop_width.

x_2string nullable

Define the x_2 position for cropping. Cannot be specified with crop_width, and must have an x_1 specified.

y_1string nullable

Define the y_1 position for cropping. You can specify either y_1 & y_2 or y_1 and crop_height.

y_2string nullable

Define the y_2 position for cropping. Cannot be specified with crop_height, and must have a y_1 specified.

crop_widthstring nullable

Use either a number, a percentage like 30.5% or a px measure like 100px.

Define the width for cropping. Cannot be specified with crop_height, and must have a x_1 specified.

crop_heightstring nullable

Define the x_2 position for cropping. Cannot be specified with crop_width, and must have a y_1 specified.

Response

OK

Changes

No recorded changes to this endpoint across all 1 revision of this API.