Here are all available conversion options you can use in the "options" section of conversions (see the example JSON below the table).
Here are all available conversion options you can use in the "options" section of conversions (see the example JSON on the right).
| Option Name | Description |
|---|---|
|
allow_multiple_outputs
Type: boolean Default: False |
If the conversion produces more than one output file, by default all of them are compressed in just one file. Set this option to true if you want a download link for each file. |
|
allow_multiple_outputs_threshold
Type: integer Minimum: 2 Maximum: 400 |
|
|
aspect_ratio
Type: string Pattern: ^\d{1,6}:\d{1,6}$ |
Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored. |
|
download_password
Type: string Pattern: ^[ -~]{0,1000}$ Example: secret_password |
A password to protect the download. To download the file send the password in the x-oc-download-password header or set a cookie named x-oc-download-password. The value contains a comma separated list of passwords. |
|
dpi
Type: integer Minimum: 10 Maximum: 1200 |
Horizontal and vertical density of the image (referred as DPI) |
|
height
Type: number Minimum: True Maximum: 65000 |
Sets the height of the image in pixels or percentage depending on the resize_unit value |
|
resize_by
Type: string Enum: px perc inches cm mm |
Sets the unit of measurement for the image's width and height |
|
resize_handling
Type: string Enum: stretch keep_aspect_ratio_fill_black keep_aspect_ratio_fill_white keep_aspect_ratio_fill_blurred keep_aspect_ratio_fill_transparent keep_aspect_ratio_crop |
Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image. |
|
resize_target
Type: string Enum: bmp gif ico jpg png tga tiff webp |
The image output format |
|
width
Type: number Minimum: True Maximum: 65000 |
Sets the width of the image in pixels or percentage depending on the resize_unit value |
POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Oc-Api-Key: <your API key here>
Content-Type: application/json
{
"input": [{
"type": "remote",
"source": "https://example-files.online-convert.com/raster%20image/png/example_small.png"
}],
"conversion": [{
"category": "operation",
"target": "resize-image",
"options": {
<conversion options here>
}
}]
}