Here you can see all available conversion options which you can use within the "options" section of conversions (see the example JSON below the table).
Here you can see all available conversion options which you can use within 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. |
height
Type: number Minimum: True Maximum: 65000 |
Sets the height of the image in pixels |
model
Type: string Enum: generic |
The optimized model to use |
resize_unit
Type: string Enum: px perc |
Sets the unit of measurement for the image's width and height |
target_format
Type: string Enum: auto bmp eps gif ico jpg png svg tga tiff webp wbmp |
Sets the upscaled image format. If set to "auto", it will use the same format as the input file. If the format is not supported, it will default to png. |
upscale_factor
Type: string Enum: 2x 4x |
The upscaling factor |
width
Type: number Minimum: True Maximum: 65000 |
Sets the width of the image in pixels |
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": "ai_upscale",
"options": {
<conversion options here>
}
}]
}