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 |
|
cut_points
Type: array Additionalproperties: False Start: string ^\d\d:\d\d:\d\d[.]\d\d\d$ Defines the start time of the video segment to keep. The format is HH:MM:SS.MS, where HH = hours, MM = minutes, SS = seconds, and MS = milliseconds. Example 00:02:23.005. End: string ^\d\d:\d\d:\d\d[.]\d\d\d$ Defines the start time of the video segment to keep. The format is HH:MM:SS.MS, where HH = hours, MM = minutes, SS = seconds, and MS = milliseconds. Example 00:02:23.005. |
An alternative to the length and number_of_parts options. Holds an array of precise cut points. |
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. |
end_video
Type: string Pattern: ^\d\d:\d\d:\d\d[.]\d\d\d$ |
Defines the ending point of the video segment to be divided when using the length or number_of_parts options. The format is HH:MM:SS.MS, where HH = hours, MM = minutes, SS = seconds, and MS = milliseconds. Example 00:02:23.005. |
length
Type: integer Minimum: True Maximum: 14400 |
An alternative to the cut_points and number_of_parts options. Splits the video into segments of <length> seconds. |
number_of_parts
Type: integer Minimum: 2 Maximum: 480 |
An alternative to the cut_points and length options. Splits the video into a specified number of equal-length parts. |
start_video
Type: string Pattern: ^\d\d:\d\d:\d\d[.]\d\d\d$ |
Defines the starting point of the video segment to be divided when using the length or number_of_parts options. The format is HH:MM:SS.MS, where HH = hours, MM = minutes, SS = seconds, and MS = milliseconds. Example 00:02:23.005. |
target_format
Type: string Enum: copy avi mkv mov mp4 |
Specifies the output video format. If omitted or set to "copy", the output format will match the input format. |
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": "cut-video",
"options": {
<conversion options here>
}
}]
}