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. |
|
allow_multiple_outputs_threshold
Type: integer Minimum: 2 Maximum: 400 |
|
|
audio_channels
Layout: string Mono: Stereo: 2.1: 3: 3.0-back: 4: Quad: Quad-side: 3.1: 5: 5.0-side: 4.1: 5.1: 5.1-side: 6: 6.0-front: Hexagonal: 6.1: 6.1-back: 6.1-front: 7: 7.0-front: 7.1: 7.1-wide: 7.1-wide-side: Octagonal: Hexadecagonal: The desired channels layout. If not set, we try to arrange the received audio inputs as best as possible. Back_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as back center audio channel Back_left: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as back left audio channel Back_right: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as back right audio channel Front_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as front center audio channel Front_left: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as front left audio channel Front_left_of_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as front left of center audio channel Front_right: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as front right audio channel Front_right_of_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as front right of center audio channel Low_frequency: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as low frequency audio channel Side_left: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as side left audio channel Side_right: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as side right audio channel Top_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top center audio channel Top_front_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top front center audio channel Top_front_left: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top front left audio channel Top_front_right: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top front right audio channel Top_back_center: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top back center audio channel Top_back_left: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top back left audio channel Top_back_right: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the file to use as top back right audio channel Wide_left: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the wide left audio channel Wide_right: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ The input_id of the wide right audio channel |
|
|
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. |
|
input_filters
Type: array Additionalproperties: False Input_id: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ 1 Defines the input_id of the input file to which you want to apply the filter Filter_name: string Volume: The filter to apply the selected filter to the input_id Filter_value: string The value(s) to use with the selected filter as a comma separated list |
|
|
keep_original_audio
Type: boolean Default: False |
Keeps the audio streams from the original video. To modify relative volumes, please refer to the input_filters option. |
|
loop_audio
Type: boolean Default: False |
If the video duration is longer than the audio, it loops the audio up to the video's length |
|
metadata
Type: array Additionalproperties: False Input_id: string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ 1 Defines the input_id of the input file to which you want to specify the properties. Language: string ^[a-z]{3}$ The language (using ISO 639-2/T standard) of the stream contained in the input file specified by the input_id field. |
|
|
video_format
Type: string Enum: avi flv mkv mov mp4 mpg ogv webm wmv |
The format of the merged file. If this option is missed, the target is the same as the original video. |
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": "merge-streams",
"options": {
<conversion options here>
}
}]
}