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 operation 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 |
Sets the threshold for the number of output files during conversion. This option is considered only when `allow_multiple_outputs` is set to true. If the generated output files exceed this threshold, they are compressed into one file. Conversely, if the threshold is not met, each output file remains uncompressed. |
dpi
Type: integer Minimum: 10 Maximum: 300 |
Horizontal and vertical density of the image (referred as DPI) |
height
Type: integer Minimum: 10 Maximum: 500 |
Specifies the screen height in pixels |
interlace
Type: string Enum: line plane |
Sets the type of interlacing scheme |
pages
Type: string Pattern: ^(((\d+|first)-?(\d*|last))|(first)|(last))(, ?(((\d+|first)-?(\d*|last))|(first)|(last)))*$ Default: 1-last |
The numbers of the pages that should be extracted and converted to image thumbnails. E.g. 5-8,10. Aliases like "first" and "last" are also accepted. |
thumbnail_target
Type: string Enum: jpg png Default: png |
Sets the thumbnail's target format |
width
Type: integer Minimum: 10 Maximum: 500 |
Specifies the screen width 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": "thumbnail",
"options": {
<conversion options here>
}
}]
}