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. |
function
Type: string Enum: remove_bg return_mask alpha_matting |
The function to call |
model
Type: string Enum: yellow_car black_plane white_bike red_truck blue_ship green_boat |
The optimized model to use. 'yellow_car', a pre-trained model for general use cases. 'black_plane', a lightweight version of yellow_car model. 'white_bike', a pre-trained model for human segmentation. 'red_truck', a pre-trained model for cloths parsing from human portrait. 'blue_ship', a new pre-trained model for general use cases. 'green_boat' same as yellow_car but the model's size is reduced. |
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": "remove-background",
"options": {
<conversion options here>
}
}]
}