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 |
---|---|
ai_upscale
Type: boolean |
Use AI to upscale image |
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. |
alpha_channel
Type: string Pattern: ^(auto_create|(#[a-f0-9]{6}))$ Example: #ffffff |
Make the background of an image transparent by adding an alpha channel. 'auto_create' will try to detect the background automatically. Specifying a color in the format #rrggbb will set this color to be transparent. |
antialias
Type: boolean |
|
bitdepth
Type: integer Enum: 1 8 16 |
Change the bit depth resolution per sample |
black_white_threshold
Type: integer Minimum: False Maximum: 255 |
Sets the black/white threshold. If set to zero, a calculated average threshold is used |
color
Type: string Enum: colored gray monochrome negate 1980 1900 Default: colored |
Color to apply the image |
colorize_model_name
Type: string Enum: generic nature_people |
Use Artificial Intelligence to colorize old black and white pictures with a specific training model |
colorize_render_factor
Type: int Minimum: 7 Maximum: 40 |
Use Artificial Intelligence to colorize old black and white pictures with a specific render factor |
crop_bottom
Type: integer Minimum: False Maximum: 100000 |
Crop from the bottom. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_height
Type: integer Minimum: True Maximum: 65000 |
Specifies the height in pixels of the crop area. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_left
Type: integer Minimum: False Maximum: 100000 |
Crop from the left side. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_origin_x
Type: integer Minimum: False Maximum: 65000 |
Specifies the X origin coordinate in pixels of the crop area starting from the upmost left corner of the image. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_origin_y
Type: integer Minimum: False Maximum: 65000 |
Specifies the Y origin coordinate in pixels of the crop area starting from the upmost left corner of the image. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_right
Type: integer Minimum: False Maximum: 100000 |
Crop from the right side. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_top
Type: integer Minimum: False Maximum: 100000 |
Crop from the top. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
crop_width
Type: integer Minimum: True Maximum: 65000 |
Specifies the width in pixels of the crop area. Use either the cropping from crop_top/bottom/left/right or crop_origin_x/y and crop_width/height. |
deskew
Type: boolean |
|
despeckle
Type: boolean |
|
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) |
enhance
Type: boolean |
|
equalize
Type: boolean |
|
height
Type: number Minimum: True Maximum: 65000 |
Sets the height of the image in pixels or percentage depending on the resize_unit value |
multilayer
Type: boolean Default: False |
The result will either be a single file with multiple layers or multiple files where each contains a single layer |
normalize
Type: boolean |
|
output_filename
Type: string Pattern: ^[\w\W]{0,255}$ Example: my_base_filename_without_extension |
The desired file name of the converted file WITHOUT the file extension. |
preset
Type: string Pattern: ^[\w\W]{1,255}$ |
Predefined options |
resolution_unit
Type: string Enum: none inches cm Default: inches |
Resolution unit when the dpi option is specified |
rotate
Type: integer Minimum: True Maximum: 359 |
Rotate image to specified degrees |
sharpen
Type: boolean |
|
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": "image",
"target": "tiff",
"options": {
<conversion options here>
}
}]
}