Reference

Conversion options explorer

Every public target and its per-conversion options, straight from GET /v2/conversions. Search by format or option name, or filter by category.

Archive (4)

7Z 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
encrypt_password string A password to encrypt the archive
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
BZ2 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
GZ 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
ZIP 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
encrypt_password string A password to encrypt the archive
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options

Audio (11)

AAC 18 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 6, 8, 12, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, heaac1, heaac2 Sets the audio codec
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
AIFF 17 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 6, 8, 12, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 1000, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
FLAC 17 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitdepth integer 8, 16, 24, 32 Change bit depth resolution
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 1000, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
M4A 18 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 6, 8, 12, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps. It can be used with the aac audio codec only.
audio_codec string aac, heaac1, heaac2, alac, copy Sets the audio codec
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 1000, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
M4R 17 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_codec string aac, heaac1, heaac2, alac, copy Sets the audio codec
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 1000, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
MMF 16 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 6, 8, 12, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 4000, 8000, 11025, 22050, 44100 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
MP3 19 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_vbr integer 65, 85, 100, 115, 130, 160, 165, 175, 190, 225, 245 If selected, a variable bitrate conversion is processed. The values are the average bitrate in kbit/s.
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_coverart boolean Remove the cover art image
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
OGG 19 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 6, 8, 12, 16, 24, 32, 44, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 500 Audio bitrate in kbps.
audio_codec string flac, opus, speex, vorbis, copy Sets the audio codec
audio_vbr integer 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 500 If selected, a variable bitrate conversion is processed. The values are the average bitrate in kbit/s per stereo channel. Only working for vorbis.
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
OPUS 17 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 6, 8, 12, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 8000, 12000, 16000, 24000, 48000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
WAV 18 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitdepth integer 8, 16, 24, 32 Change bit depth resolution
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 1000, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
pcm_format string pcm_alaw, pcm_f32be, pcm_f32le, pcm_f64be, pcm_f64le, pcm_mulaw, pcm_s16be, pcm_s16le, pcm_s24be, pcm_s24le, pcm_s32be, pcm_s32le, pcm_s8, pcm_u16be, pcm_u16le, pcm_u24be, pcm_u24le, pcm_u32be, pcm_u32le, pcm_u8 PCM formats.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
WMA 18 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
audio_bitrate integer 8, 12, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string wma1, wma2, copy Sets the audio codec
channels string stereo, mono Audio channels.
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
frequency integer 1000, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
language_tts string ar-SA, bg-BG, ca-ES, cs-CZ, da-DK, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-IN, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-CH, fr-FR, hi-IN, hr-HR, hu-HU, id-ID, it-IT, ja-JP, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, tr-TR, vi-VN, zh-CN, zh-HK Language of the speaker
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23

CAD (2)

DWG 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
version string AC1009, AC1012, AC1014, AC1015, AC1018, AC1021, AC1024, AC1027, AC1032 The internal AutoCAD version code of the output file. E.g. AC1018 for compatibility with AutoCAD 2004, 2005, 2006
DXF 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
version string AC1009, AC1012, AC1014, AC1015, AC1018, AC1021, AC1024, AC1027, AC1032 The internal AutoCAD version code of the output file. E.g. AC1018 for compatibility with AutoCAD 2004, 2005, 2006

Document (11)

DOC 12 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_mode string layout text, layout Optical character recognition optimization for text correctness or layout as close as possible to the original one
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rasterize_input boolean Pre process the input files (PDF only) and convert them to a raster image before OCR processing. It can help to achieve better results with PDF files containing a mix of texts and images containing text.
DOCX 12 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_mode string layout text, layout Optical character recognition optimization for text correctness or layout as close as possible to the original one
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rasterize_input boolean Pre process the input files (PDF only) and convert them to a raster image before OCR processing. It can help to achieve better results with PDF files containing a mix of texts and images containing text.
HTML 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
ODT 10 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
PDF 49 options
Option Type Default Allowed / range Description
add_borders boolean Draw a border frame around each logical page when using pages_per_sheet
alignment string stretch, center, top, bottom How to place the watermark or the stamp on each page. "stretch" scales it to cover the full page; "center", "top" and "bottom" keep the watermark at its original size and position it accordingly.
allow_copying boolean Allows copying of the document
allow_modification boolean Allows modification of the document
allow_multiple_outputs boolean 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 integer 2–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.
allow_printing boolean Allows printing of the document
border_bottom number The page's bottom border in the unit specified by border_unit
border_left number The page's left border in the unit specified by border_unit
border_right number The page's right border in the unit specified by border_unit
border_top number The page's top border in the unit specified by border_unit
border_unit string mm, cm, in, pt The unit of measurement to apply to the border options
color string rgb, cmyk, gray The color schema
compression string basic, strong Selects the compression level of the converted file
custom_page_size_height string The height of the pages. The unit has to be specified in the custom_page_size_unit field. For best precision if using inchs, please use 4 decimal digits.
custom_page_size_unit string mm, in The unit of measurement of the pages.
custom_page_size_width string The width of the pages. The unit has to be specified in the custom_page_size_unit field. For best precision if using inchs, please use 4 decimal digits.
deskew boolean Deskew a PDF created with a scanner not correctly aligned with the original document
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of images inside the document (referred to as DPI)
file_size integer 1–1048576 Limit the target size of the file you want to convert to PDF to this size in Kbytes (KiB). We try to do our best to achieve this limit as close as possible.
grayscale boolean Grayscale all images inside the PDF
images_quality integer 10–100 The quality of the embedded images (range from 10 to 100). 100 is the highest quality.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
linearize boolean Optimizes the converted file for web visualization
merge boolean Merges the input files in one output file using the same order as the files appear in the input section of the message.
new_owner_password string ^[\w\W]{0,64}$ Adds or changes the owner's password (up to 64 characters)
new_user_password string ^[\w\W]{0,64}$ Adds or changes the user's password (up to 64 characters)
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_page_structure string auto, osd_only, raw_line, single_char, single_column, single_line, single_word, sparse_text, sparse_text_osd, uniform_block_vertical, uniform_text, unstructured Page structure description to the OCR engine. It may help to have a better result. If your first attempt with automatic page structure detection fails or if you know in advance the structure of your pages, you can try with a more specific one.
one_file_per_page boolean If set, the original document is split in more PDF files, one per page
orientation string portrait, landscape The page's orientation
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
page_size string a0, a1, a2, a3, a4, a4small, a5, a6, a7, a8, a9, a10, isob0, isob1, isob2, isob3, isob4, isob5, isob6, c0, c1, c2, c3, c4, c5, c6, 11x17, ledger, legal, letter, lettersmall, archA, archB, archC, archD, archE, jisb0, jisb1, jisb2, jisb3, jisb4, jisb5, jisb6, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, hagaki The size of the pages
pages_per_sheet integer 2, 4, 6, 8, 9, 16 Number of input pages to fit on a single output sheet. The layout is automatically determined based on the source page orientation unless differently specified by the option orientation.
preset string ^[\w\W]{1,255}$ Predefined options
quality string screen, ebook, default, printer, prepress, minimum, insane Optimizes the output for a specific target which will produce different output file sizes. It may override other quality options.
rasterize_dpi integer 10–1200 The resulting document will contain images of the pages that have non-selectable text only. They will have the specified DPI value.
rearrange string ^(((\d+|first)-?(\d*|last))|(first)|(last)|(even)|(odd))(, ?(((\d+|first)-?(\d*|last))|(first)|(last)|(even)|(odd)))*$ The page numbers that should be present in the converted file, in the desired order. This is also used to delete pages or extract a set of pages.
split string ^((\d+-?\d*)(, ?(\d+-?\d*))*|all)$ The pages where to split the original file. E.g. in a 30 pages document, an entry of 10,20 will results in three output files with pages 1-10, 11-20, 21-30. It also accepts "all" to split all pages into separate files.
split_page_x integer 2–50 Split all the PDF pages in the specified number of parts along the horizontal axis. E.g. from one A4 landscape page to two A5 portrait pages.
split_page_y integer 2–50 Split all the PDF pages in the specified number of parts along the vertical axis. E.g. from one A4 portrait page to two A5 landscape pages.
stamp boolean Insert the first page of the second input as a stamp into each page of the first input.
stretch_resizing boolean If set, the source page is stretched to fill the target dimensions exactly, ignoring its aspect ratio.
version string 1.4, 1.5, 1.6, 1.7, 2.0 Selects the PDF version of the converted file
watermark boolean Insert the first page of the second input as a watermark into each page of the first input.
PPT 11 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_mode string layout text, layout Optical character recognition optimization for text correctness or layout as close as possible to the original one
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
PPTX 11 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_mode string layout text, layout Optical character recognition optimization for text correctness or layout as close as possible to the original one
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
RTF 12 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_mode string layout text, layout Optical character recognition optimization for text correctness or layout as close as possible to the original one
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rasterize_input boolean Pre process the input files (PDF only) and convert them to a raster image before OCR processing. It can help to achieve better results with PDF files containing a mix of texts and images containing text.
TXT 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_engine string red_kiwi Selects the optimized engine depending on how the source file was created
ocr_engine_options string Object containing specific engine options.
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
ocr_mode string layout text, layout Optical character recognition optimization for text correctness or layout as close as possible to the original one
ocr_page_structure string auto, osd_only, raw_line, single_char, single_column, single_line, single_word, sparse_text, sparse_text_osd, uniform_block_vertical, uniform_text, unstructured Page structure description to the OCR engine. It may help to have a better result. If your first attempt with automatic page structure detection fails or if you know in advance the structure of your pages, you can try with a more specific one.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
XLS 10 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
XLSX 8 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tgl, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options

Ebook (10)

AZW3 15 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
embed_font string sans, serif Embed generic font
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string Kindle, Kindle DX, Kindle Fire, Kindle Oasis, Kindle Paperwhite, Kindle Paperwhite 3, Kindle Scribe, Kindle Voyage Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
EPUB 16 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
embed_font string sans, serif Embed generic font
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, Apple iPad, Apple iPad 3, Cybook 3, Cybook Opus, Ectaco jetBook, Galaxy, Generic e-ink, Generic HD e-ink, Generic large e-ink, Hanlin V3, Hanlin V5, iLiad, IrexDR800, IrexDR1000, jetBook, Kobo, Mobipocket, MS Reader, Nook, Nook Color, Nook HD Plus, Pocketbook 900, Pocketbook Pro 912, Pocketbook InkPad 3, Pocketbook InkPad Lux, Pocketbook InkPad HD, Sony, Sony 300, Sony 900, Sony Landscape, Sony T3, Tablet Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
version string 2, 3 The format's version
FB2 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, Cybook 3, Cybook Opus, Ectaco jetBook, Hanlin V3, Hanlin V5, Pocketbook 900, Pocketbook Pro 912, Pocketbook InkPad 3, Pocketbook InkPad Lux, Pocketbook InkPad HD Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
LIT 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string MS Reader, Hanlin V3, Hanlin V5 Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
LRF 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, Sony, Sony 300, Sony 900, Sony Landscape, Sony T3 Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
MOBI 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, Cybook 3, Cybook Opus, Ectaco jetBook, Hanlin V3, Hanlin V5, iLiad, Kindle, Kindle DX, Kindle Fire, Kindle Oasis, Kindle Paperwhite, Kindle Paperwhite 3, Kindle Voyage, Kobo, Pocketbook 900, Pocketbook Pro 912, Pocketbook InkPad 3, Pocketbook InkPad Lux, Pocketbook InkPad HD Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
PDB 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, IrexDR800, IrexDR1000, Nook, Nook Color, Nook HD Plus Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
PDF 27 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
embed_font string sans, serif Embed generic font
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language string ^[a-zA-Z_,-]{3,128}$ Language for the source (using ISO 639-2/T standard). In case of multi language documents, a comma separated list of values without quotes or spaces can be used. Please note that both plain and script languages cannot be included at the same time. Supported values are: afr, amh, ara, asm, aze, aze_cyrl, bel, ben, bod, bos, bre, bul, cat, ceb, ces, chi_sim, chi_sim_vert, chi_tra, chi_tra_vert, chr, cos, cym, dan, deu, div, dzo, ell, eng, enm, epo, est, eus, fao, fas, fil, fin, fra, frk, frm, fry, gla, gle, glg, grc, guj, hat, heb, hin, hrv, hun, hye, iku, ind, isl, ita, ita_old, jav, jpn, jpn_vert, kan, kat, kat_old, kaz, khm, kir, kmr, kor, kor_vert, lao, lat, lav, lit, ltz, mal, mar, mkd, mlt, mon, mri, msa, mya, nep, nld, nor, oci, ori, pan, pol, por, pus, que, ron, rus, san, sin, slk, slv, snd, spa, spa_old, sqi, srp, srp_latn, sun, swa, swe, syr, tam, tat, tel, tgk, tha, tir, ton, tur, uig, ukr, urd, uzb, uzb_cyrl, vie, yid, yor, script-Arabic, script-Armenian, script-Bengali, script-Canadian_Aboriginal, script-Cherokee, script-Cyrillic, script-Devanagari, script-Ethiopic, script-Fraktur, script-Georgian, script-Greek, script-Gujarati, script-Gurmukhi, script-Hangul, script-Hangul_vert, script-HanS, script-HanS_vert, script-HanT, script-HanT_vert, script-Hebrew, script-Japanese, script-Japanese_vert, script-Kannada, script-Khmer, script-Lao, script-Latin, script-Malayalam, script-Myanmar, script-Oriya, script-Sinhala, script-Syriac, script-Tamil, script-Telugu, script-Thaana, script-Thai, script-Tibetan, script-Vietnamese
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
ocr boolean Optical character recognition
ocr_filter string gray Apply a filter to the input file. It may improve text detection.
ocr_filter_options string Object containing specific filter options.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
paper_size string a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3, b4, b5, b6, legal, letter The size of the paper. Default is letter.
pdf_add_toc boolean Adds a Table of Contents at the end of the PDF that lists page numbers.
pdf_default_font_size number 4–1000 The default font size (in pixels)
pdf_no_cover boolean Do not insert the book cover as an image at the start of the document.
pdf_page_margin_bottom number 0–10000 The size of the bottom page margin, in pts. Default is 72pt. Overrides the common bottom page margin setting, unless set to zero.
pdf_page_margin_left number 0–10000 The size of the left page margin, in pts. Default is 72pt. Overrides the common left page margin setting, unless set to zero.
pdf_page_margin_right number 0–10000 The size of the right page margin, in pts. Default is 72pt. Overrides the common right page margin setting, unless set to zero.
pdf_page_margin_top number 0–10000 The size of the top page margin, in pts. Default is 72pt. Overrides the common top page margin setting, unless set to zero.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, Apple iPad, Apple iPad 3, Cybook 3, Cybook Opus, Ectaco jetBook, Galaxy, Generic e-ink, Generic HD e-ink, Generic large e-ink, Hanlin V3, Hanlin V5, iLiad, IrexDR800, IrexDR1000, jetBook, Kindle, Kindle DX, Kindle Fire, Kindle Oasis, Kindle Paperwhite, Kindle Paperwhite 3, Kindle Voyage, Kobo, Mobipocket, MS Reader, Nook, Nook Color, Nook HD Plus, Pocketbook 900, Pocketbook Pro 912, Pocketbook InkPad 3, Pocketbook InkPad Lux, Pocketbook InkPad HD, Sony, Sony 300, Sony 900, Sony Landscape, Sony T3, Tablet Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)
PDF-EBOOK 7 options
Option Type Default Allowed / range Description
ascii boolean ASCII output
author string Change ebook author
border integer Add border in centimeters
embed_font string sans, serif Embed generic font
encoding string Change the input encoding
reader string Kindle, Kindle DX, Kindle Fire, Kindle Paperwhite, Kindle Voyage, Apple iPad, Apple iPad 3, Galaxy, Sony, Sony 300, Sony 900, Sony Landscape, Sony T3, MS Reader, Mobipocket, Hanlin V3, Hanlin V5, Cybook 3, Cybook Opus, iLiad, IrexDR800, IrexDR1000, jetBook, Kobo, Nook, Nook Color, Nook HD Plus, Bambook, Tablet, Generic e-ink, Generic large e-ink, Pocketbook 900, Pocketbook Pro 912 Target ebook for better compatibility
title string Change ebook title
TCR 14 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
ascii boolean ASCII output
author string ^[\w\W]{0,512}$ Change ebook author (up to 512 characters)
base_font_size integer 6–22 Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value.
border integer 0–20 Add border in centimeters
download_password string ^[ -~]{0,1000}$ 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.
enable_heuristics boolean Enable heuristic processing
encoding string ascii, cp1250, cp1251, cp1252, cp1253, cp1254, cp1257, iso8859_1, iso8859_2, iso8859_4, iso8859_5, iso8859_7, iso8859_9, iso8859_13, iso8859_15, koi8_r, utf8, utf-16, euc_jp, sjis, iso2022jp, gbk, iscii91, big5, tis620, gb2312, ISO-2022-KR Change the input encoding
language_stt string ar-AR, ca-ES, zh-CN, cs-CZ, de-DE, el-GR, en-IN, en-US, es-ES, fa-IR, fr-FR, hi-IN, it-IT, ja-JP, kk-KZ, nl-NL, pl-PL, pt-FB, sv-SE, ru-RU, tl-PH, tr-TR, uk-UA, vi-VN Language of the audio source
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
reader string default, Pocketbook 900, Pocketbook Pro 912, Pocketbook InkPad 3, Pocketbook InkPad Lux, Pocketbook InkPad HD Choose a target ebook reader for better compatibilty
title string ^[\w\W]{0,512}$ Change ebook title (up to 512 characters)

Hash & checksums (23)

ADLER32 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
APACHE-HTPASSWD 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
salt string ^[\w\W]{0,5000}$ Shared secret key used as additional input to defend against some attacks.
BLOWFISH 7 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rounds integer 1–15 Number of rounds used by the encryption engine
salt string ^[\w\W]{0,5000}$ Shared secret key used as additional input to defend against some attacks.
CRC32 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
CRC32B 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
GOST 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
HAVAL128 7 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rounds integer 3, 4, 5 Number of rounds used by the encryption engine
MD4 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
MD5 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
RIPEMD128 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
RIPEMD160 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
SHA1 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
SHA256 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
SHA384 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
SHA512 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
SNEFRU 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
STD-DES 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
salt string ^[\w\W]{0,5000}$ Shared secret key used as additional input to defend against some attacks.
TIGER128 7 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rounds integer 3, 4 Number of rounds used by the encryption engine
TIGER128-CALCULATOR 0 options

No options — pass { "category": "hash", "target": "tiger128-calculator" }.

TIGER128-CONVERTER 0 options

No options — pass { "category": "hash", "target": "tiger128-converter" }.

TIGER160 7 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rounds integer 3, 4 Number of rounds used by the encryption engine
TIGER192 7 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rounds integer 3, 4 Number of rounds used by the encryption engine
WHIRLPOOL 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
hmac string ^[\w\W]{0,1000}$ Shared secret key used for the HMAC variant.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options

Image (14)

AVIF 33 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
BMP 33 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
EPS 30 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
antialias boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
EXR 30 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
antialias boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
GIF 38 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
compress string none, low, medium, high, best If set, this option tries to compress your file even more with no perceivable loss of quality
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
do_not_flatten boolean Do not flatten the image
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
framerate integer 6–30 Specifies the video frames per second
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
input_colorspace string sRGB Sets the input image's colorspace
interlace string line, none, plane Sets the type of interlacing scheme
iterations integer 1–256 This option specifies the number of times the animation will repeat before coming to a stop.
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
ICO 32 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height integer 1–256 Specifies the screen height in pixels
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width integer 1–256 Specifies the screen width in pixels
JPG 38 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
antialias boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
colorspace string CMYK, Gray, HSL, HSV, LAB, RGB, sRGB, YCbCr Sets the image's colorspace
compress string none, low, medium, high, best If set, this option tries to compress your file even more with no perceivable loss of quality
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
interlace string line, none, plane Sets the type of interlacing scheme
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
number_of_frames integer 1–500 Specifies the number of frames to extract from a video file
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
quality integer 0–100 Level of quality from 0 (worst quality, smaller file size) to 100 (best quality, greater file size)
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sampling_factor string 4:4:4, 4:4:0, 4:2:2, 4:2:0, 4:1:1, 4:1:0 Sets the chroma sub-sampling method to use
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
PNG 37 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
colorspace string CMYK, Gray, HSL, HSV, LAB, RGB, sRGB, YCbCr Sets the image's colorspace
compress string none, low, medium, high, best If set, this option tries to compress your file even more with no perceivable loss of quality
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
interlace string line, none, plane Sets the type of interlacing scheme
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
quality integer 0–100 Level of quality from 0 (worst quality, smaller file size) to 100 (best quality, greater file size)
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
SVG 31 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–100 Sets a threshold to decide which area will become black and which white. 100 = full black
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
speckles_threshold integer 8–10000000 The min length in pixels of a closed line to be recognized as a vectorial path
svg_engine string green_strawberry, blue_apple, yellow_orange Selects a specific engine for SVG conversions
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
TGA 33 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
colorspace string CMYK, Gray, HSL, HSV, LAB, RGB, sRGB, YCbCr Sets the image's colorspace
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
TIF 36 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
bitdepth integer 1, 8, 16, 32 Change the bit depth resolution per sample
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
colorspace string CMYK, Gray, HSL, HSV, LAB, RGB, sRGB, YCbCr Sets the image's colorspace
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
multilayer boolean The result will either be a single file with multiple layers or multiple files where each contains a single layer
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
TIFF 36 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
alpha_channel string ^(auto_create|(#[a-f0-9]{6}))$ 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 boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
bitdepth integer 1, 8, 16, 32 Change the bit depth resolution per sample
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
colorspace string CMYK, Gray, HSL, HSV, LAB, RGB, sRGB, YCbCr Sets the image's colorspace
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
multilayer boolean The result will either be a single file with multiple layers or multiple files where each contains a single layer
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
WBMP 30 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
antialias boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
WEBP 32 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
antialias boolean
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
black_white_threshold integer 0–255 Sets the black/white threshold. If set to zero, a calculated average threshold is used
color string colored 1900, 1980, colored, gray, monochrome, negate, sepia Color to apply the image
colorize_model_name string generic, nature_people Use Artificial Intelligence to colorize old black and white pictures with a specific training model
colorize_render_factor int 7–40 Use Artificial Intelligence to colorize old black and white pictures with a specific render factor
crop_bottom integer 0–199999 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 integer 1–200000 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 0–199999 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 integer 1–200000 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 boolean
despeckle boolean
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
enhance boolean
equalize boolean
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
mirror string none, horizontal, vertical Mirror/flip your image horizontally or vertically
normalize boolean
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
rotate integer 1–359 Rotate image to specified degrees
sharpen boolean
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value

Metadata (2)

JSON 4 options
Option Type Default Allowed / range Description
download_password string ^[ -~]{0,1000}$ 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.
keys_format string snake_lowercase original, capital_first, snake_lowercase, snake_uppercase, lowercase_nospaces, lowercase_with_spaces, uppercase_nospaces, uppercase_with_spaces The returned metadata keys' format. (E.g. Color Space, color_space, COLOR_SPACE, colorspace, color space, COLORSPACE, COLOR SPACE)
output_mode string basic basic, expert Returns a more or less detailed output
type string document, image, video, audio
METADATA 1 option
Option Type Default Allowed / range Description
download_password string ^[ -~]{0,1000}$ 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.

Operations & tools (19)

ANALYZE-IMAGE 7 options
Option Type Default Allowed / range Description
age boolean 1 Enabling this option triggers the identification of the age of individuals depicted in the images. It provides insights into the approximate age range of people captured in the visual content.
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
max_outputs_per_input integer 1–2048 Specifies the maximum number of outputs to be generated per input file during the conversion process. If the conversion yields more than one output per input, only the specified number of outputs will be returned.
nsfw boolean 1 When enabled, this option activates the detection of Not Safe For Work (NSFW) content in images. It provides an indication of whether explicit or inappropriate material is present.
prompt boolean When activated, this option includes a textual description prompt that provides insights into the content in images.
AUDIO-VOLUME 10 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
normalize boolean Normalize the audio volume.
normalize_loudness_range_target_ebu number 1–50 EBU Loudness Range Target in LUFS (default 7.0). Ignored if normalize_type is not ebu.
normalize_target_level integer -99–0 Normalization target level in dB/LUFS (default -23). Ignored when normalize_type=ebu.
normalize_target_level_ebu number -70–-5 Integrated Loudness Target in LUFS. Ignored if normalize_type is not ebu.
normalize_true_peak_ebu number -9–0 EBU Maximum True Peak in dBTP (default -2.0). Ignored if normalize_type is not ebu.
normalize_type string ebu, rms, peak Normalization type, brings the signal to the specified RMS or peak level, or applies EBU R128 for broadcasting.
volume string (^([0-4]\.?[0-9]{1,2}?$)|^5(\.0)?$)|(^-[1-9]?[0-9]dB$)|(^[+]?[1-2]?[0-9]dB$) Sets the new volume level. For example, a value of 0.5 will reduce the volume by half, while a value of 2 will double it. It is possible to use decibel values too. E.g. -10dB or +5dB.
COMPARE-IMAGE 6 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
diff_color string red, green, blue, yellow, orange, violet, black, white The color to use to show the pixels that are different in the diff image
download_password string ^[ -~]{0,1000}$ 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.
method string ae, butteraugli, lpips, mae, ncc, psnr, rmse, ssim The algorithm to use for image comparison
threshold number 0–100 Sets the threshold in percentage over which color is to be considered different between the two images. A zero means that the pixels have to be identical to be considered equal.
COMPARE-PDF 3 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
COMPARE-VIDEO 3 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
COMPRESS 10 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
compression_level string low, medium, high, best If set, this option tries to compress your file with no perceivable loss of quality
compression_target string gif, jpg, png Sets the target format if it's different from the input's file format
download_password string ^[ -~]{0,1000}$ 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.
file_size integer 0–1048576 Specify the target file size for the compressed image in kilobytes (KiB). We try to do our best to achieve this limit as close as possible.
file_size_perc integer 1–99 Set the target size of the image as a percentage of the original file size. We try to do our best to achieve this limit as close as possible.
quality integer 0–100 Level of quality from 0 (worst quality, smaller file size) to 100 (best quality, greater file size)
strip_metadata boolean Strips metadata from the output file
strip_metadata_jpg string Selects which metadata to remove from the output file as CSV. Possible values [all, adobe, com, exif, iptc, icc, jfif, jfxx, xmp]. It defaults to all.
CONVERT-PDFA 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
strict_mode boolean If true, it doesn't modify the input file appearance to make it PDF/A compliant
validation_profile string pdfa1a, pdfa1b, pdfa2a, pdfa2b, pdfa2u, pdfa3a, pdfa3b, pdfa3u, pdfa4, pdfa4e, pdfa4f, pdfaua1 The converted file is PDF/A compliant to the specified profile
CUT-VIDEO 8 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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 string ^\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 integer 1–14400 An alternative to the cut_points and number_of_parts options. Splits the video into segments of <length> seconds.
number_of_parts integer 2–480 An alternative to the cut_points and length options. Splits the video into a specified number of equal-length parts.
start_video string ^\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 string copy, avi, mkv, mov, mp4 Specifies the output video format. If omitted or set to "copy", the output format will match the input format.
EXTRACT-ARCHIVE 2 options
Option Type Default Allowed / range Description
download_password string ^[ -~]{0,1000}$ 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.
summary boolean Generates a JSON summary of the extracted content.
EXTRACT-ASSETS 3 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
EXTRACT-ASSETS-FROM-PDF 1 option
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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.
EXTRACT-STREAMS 4 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
stream string all, audio, video, subtitle Select the stream to extract. By default, all the available streams are extracted.
MERGE-STREAMS 8 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
audio_channels string
audio_concatenate boolean Enables sequential concatenation of audio files. When enabled, audio files are played one after another without overlaps or fades. For applying fade effects during transitions, use the `audio_fade` option instead.
download_password string ^[ -~]{0,1000}$ 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.
keep_original_audio boolean Keeps the audio streams from the original video. To modify relative volumes, please refer to the input_filters option.
loop_audio boolean If the video duration is longer than the audio, it loops the audio up to the video's length
video_format string 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.
PDF-BOOKLET 8 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
blank_page_fill string auto first, last, auto Where to insert padding blank pages when the page count is not a multiple of 4 (8 for quarter-fold).
crop_marks boolean Add printer crop/fold marks (a frame) around each imposed page.
direction string ltr ltr, rtl Reading/binding direction. RTL flips the page-pair order on each sheet.
download_password string ^[ -~]{0,1000}$ 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.
pages_per_sheet integer 2 2, 4 Logical pages per sheet side. 2 = half-fold booklet, 4 = quarter-fold brochure.
paper_size string a4 a3, a4, a5, letter, legal, b5 Target print paper size for the folded booklet sheets.
RESIZE-IMAGE 10 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the image e.g. 16:9. If used, the options width and height are ignored.
download_password string ^[ -~]{0,1000}$ 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 integer 10–1200 Horizontal and vertical density of the image (referred as DPI)
height number 1–200000 Sets the height of the image in pixels or percentage depending on the resize_unit value
resize_by string px, perc, inches, cm, mm Sets the unit of measurement for the image's width and height
resize_handling string stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_fill_transparent, keep_aspect_ratio_crop Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original image.
resize_target string bmp, gif, ico, jpg, png, tga, tiff, webp The image output format
width number 1–200000 Sets the width of the image in pixels or percentage depending on the resize_unit value
SLIDESHOW 7 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
framerate number 1–120 Specifies the video frames per second
height number 1–65000 Sets the height of the slideshow in pixels
target_format string avi, mkv, mov, mp4 The video output format
width number 1–65000 Sets the width of the slideshow in pixels
THUMBNAIL 9 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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 integer 10–300 Horizontal and vertical density of the image (referred as DPI)
height integer 10–500 Specifies the screen height in pixels
interlace string line, none, plane Sets the type of interlacing scheme
pages string 1-last ^(((\d+|first)-?(\d*|last))|(first)|(last))(, ?(((\d+|first)-?(\d*|last))|(first)|(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 string png jpg, png, webp Sets the thumbnail's target format
width integer 10–500 Specifies the screen width in pixels
VALIDATE-PDFA 4 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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.
validation_profile string pdfa1a, pdfa1b, pdfa2a, pdfa2b, pdfa2u, pdfa3a, pdfa3b, pdfa3u, pdfa4, pdfa4e, pdfa4f, pdfaua1 The input file is checked for PDF/A compliance to this profile
VIDEO-TO-IMAGE 9 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–400
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d[.]\d\d\d$ Not mandatory. Trims the end of the video and sets the ending point for frame extraction. The format is HH:MM:SS.MS, where HH = hours, MM = minutes, SS = seconds, and MS = milliseconds. Example 00:02:23.005.
images_per_time_unit integer 1–60 Number of frames to extract per unit of time, as defined by "time_unit" option.
keyframes_only boolean Extracts only keyframes, up to the limit set by "time_unit" and "images_per_time_unit" options.
start_video string ^\d\d:\d\d:\d\d[.]\d\d\d$ Not mandatory. Trims the beginning of the video and sets the starting point for frame extraction. The format is HH:MM:SS.MS, where HH = hours, MM = minutes, SS = seconds, and MS = milliseconds. Example 00:02:23.005.
target_format string bmp, eps, exr, gif, ico, jpg, png, svg, tiff, tga, wbmp, webp Specifies the output image format. Defaults to JPG if not set.
time_unit string second, minute, hour, full_video Time unit for frame extraction. If set to "full_video", frames are evenly spaced throughout the video.

Video (26)

3G2 37 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, amr-nb, amr-wb, heaac1, heaac2, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string h.263, h.264, mpeg4, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
3GP 24 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_codec string aac, amr-nb, amr-wb, heaac1, heaac2, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string h.263, h.264, mpeg4, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
format string sqcif, qcif, cif, 4cif, 16cif
framerate number 1–120 Specifies the video frames per second
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
ANDROID 5 options
Option Type Default Allowed / range Description
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
end string \d+:\d+:\d+
framerate integer
start string \d+:\d+:\d+
video_bitrate integer
AVI 38 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, ac3, adpcm_ms, heaac1, heaac2, mp2, mp3, opus, pcm_s16le, vorbis, copy Sets the audio codec
audio_frequency integer 1000, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string dx50, ffv1_v3, h.264, h.265, huffyuv, mjpeg, mpeg4, msmpeg, theora, vp8, vp9, xvid, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
ffv1_archival_use boolean Output is for archival use
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
BLACKBERRY 4 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
mirror string none, horizontal, vertical
rotate integer 90, 180, 270
start string \d+:\d+:\d+
DPG 5 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
download_password string ^[ -~]{0,1000}$ 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.
remove_audio boolean Disable the audio track
version string 4 1, 2, 3, 4 DPG Version
FLV 37 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string adpcm, aac, heaac1, heaac2, asao, mp3, opus, pcm_s16_be, pcm_s16_le, pcm_u8, speex, vorbis, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string h.264, screen_video, screen_video_2, sorenson, vp6, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
HLS 34 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, heaac1, heaac2, mp3, copy Sets the audio codec
channel string stereo, mono Audio channels.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
IPAD 8 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
framerate integer
height integer
mirror string none, horizontal, vertical
rotate integer 90, 180, 270
start string \d+:\d+:\d+
video_bitrate integer
width integer
IPHONE 4 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
mirror string none, horizontal, vertical
rotate integer 90, 180, 270
start string \d+:\d+:\d+
IPOD 4 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
mirror string none, horizontal, vertical
rotate integer 90, 180, 270
start string \d+:\d+:\d+
MKV 38 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, ac3, dts, eac3, flac, heaac1, heaac2, mp3, opus, pcm_s16le, vorbis, copy Sets the audio codec
audio_frequency integer 1000, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string av1, ffv1_v3, h.264, h.265, huffyuv, mpeg1video, mpeg2video, mpeg4, theora, vp8, vp9, xvid, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
ffv1_archival_use boolean Output is for archival use
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
MOV 37 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, ac3, alac, eac3, heaac1, heaac2, mp3, opus, pcm_s16_le, vorbis, copy Sets the audio codec
audio_frequency integer 1000, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string av1, h.264, h.265, mjpeg, mpeg1video, mpeg2video, mpeg4, prores, theora, xvid, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
MP4 38 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string aac, ac3, eac3, heaac1, heaac2, mp2, mp3, opus, vorbis, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 96000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string av1, h.264, h.265, mpeg1video, mpeg2video, mpeg4, vp9, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate or file_size is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
file_size integer 0–65536 Limit the target size of the video you want to convert to MP4 to this size in Megabyte (MiB). We try to do our best to achieve this limit as close as possible.
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
MPEG-1 35 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string mp3, mp2, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
MPEG-2 35 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string mp3, mp2, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
MPG 36 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string mp3, mp2, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string mpeg1video, mpeg2video, copy
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
NINTENDO-3DS 3 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
mirror string none, horizontal, vertical
start string \d+:\d+:\d+
NINTENDO-DS 1 option
Option Type Default Allowed / range Description
dpg integer 0, 1, 2, 3, 4 DPG Version
OGG 34 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
OGV 35 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string flac, opus, speex, vorbis, copy Sets the audio codec
audio_frequency integer 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
PS3 5 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
framerate integer
mirror string none, horizontal, vertical
start string \d+:\d+:\d+
video_bitrate integer
WEBM 37 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 8, 16, 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string vorbis, opus, copy Sets the audio codec
audio_frequency integer 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string av1, vp8, vp9, copy Sets the video codec
crf integer 0–51 The Constant Rate Factor (CRF) allows the encoder to attempt to achieve a certain output quality for the whole file when output file size is of less importance. Lower values result in better quality at the expense of a higher file size. This option will be ignored if video_bitrate is set.
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
WII 4 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
mirror string none, horizontal, vertical
rotate integer 90, 180, 270
start string \d+:\d+:\d+
WMV 36 options
Option Type Default Allowed / range Description
allow_multiple_outputs boolean 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 integer 2–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.
aspect_ratio string ^\d{1,6}:\d{1,6}$ Specify the aspect ratio of the video e.g. 16:9.
audio_bitrate integer 24, 32, 48, 56, 64, 96, 112, 128, 160, 192, 224, 256, 320 Audio bitrate in kbps.
audio_codec string wmapro, wmav1, wmav2, copy Sets the audio codec
audio_frequency integer 1000, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000 Audio frequency in Hz.
channel string stereo, mono Audio channels.
codec string msmpeg4, wmv7, wmv8, wmv9, copy Sets the video codec
crop_bottom integer 0–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 integer 1–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 0–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 integer 1–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.
default_still_frame_duration number 0.02867–1800 Defines the duration in seconds of a still frame. E.g. when converting from images or documents.
deinterlace boolean Deinterlace the video
download_password string ^[ -~]{0,1000}$ 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 string ^\d\d:\d\d:\d\d$ Sets the end point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:05:35
framerate number 1–120 Specifies the video frames per second
height integer 1–10000 Specifies the screen height in pixels
merge boolean Allows to merge the input files to a single video
mirror string none, horizontal, vertical Mirror/flip your video
normalize boolean Normalize the audio volume.
output_filename string ^[\w\W]{0,255}$ The desired file name of the converted file WITHOUT the file extension.
preset string ^[\w\W]{1,255}$ Predefined options
remove_audio boolean Disable the audio track
resize_by string px, perc Sets the unit of measurement for the image's width and height
resize_handling string stretch stretch, keep_aspect_ratio_fill_black, keep_aspect_ratio_fill_white, keep_aspect_ratio_fill_blurred, keep_aspect_ratio_crop, do_not_upscale Determine how the resizing of the image should be done. Either by stretching, keeping the original aspect ratio (filling the empty space if needed) or not upscaling the original video.
rotate integer 90, 180, 270 Rotate your video, specified in degrees clockwise
start string ^\d\d:\d\d:\d\d$ Sets the start point of the part of the video you want to keep. The format is HH:MM:SS. HH = hour, MM = minutes, SS = seconds. Example 00:02:23
video_bitrate integer 1–100000 Specifies the bitrate in kbps. This controls the average rate at which video data is processed and affects the video quality and file size.
video_buffer_size integer 1–100000 Specifies the buffer size in kb. It determines the amount of data the encoder can accumulate before it must send it to the output. A larger buffer allows more flexibility for bitrate control but can introduce latency.
video_max_bitrate integer 1–100000 Specifies the maximum bitrate in kbps. This helps to control the peak bitrate and prevent excessive bitrates that could lead to playback issues or excessive file sizes.
width integer 1–10000 Specifies the screen width in pixels
XBOX 4 options
Option Type Default Allowed / range Description
end string \d+:\d+:\d+
mirror string none, horizontal, vertical
rotate integer 90, 180, 270
start string \d+:\d+:\d+