Here you can see all available conversion options which you can use within the "options" section of conversions (see the example JSON below the table).
Here you can see all available conversion options which you can use within the "options" section of conversions (see the example JSON on the right).
Option Name | Description |
---|---|
allow_multiple_outputs
Type: boolean Default: False |
If the conversion produces more than one output file, by default all of them are compressed in just one file. Set this option to true if you want a download link for each file. |
allow_multiple_outputs_threshold
Type: integer Minimum: 2 Maximum: 400 |
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
Type: boolean Default: False |
ASCII output |
author
Type: string Pattern: ^[\w\W]{0,512}$ |
Change ebook author (up to 512 characters) |
base_font_size
Type: integer Minimum: 6 Maximum: 22 |
Force a specific base font size in pts. All of the other fonts will be scaled proportionally to this value. |
border
Type: integer Minimum: False Maximum: 20 |
Add border in centimeters |
download_password
Type: string Pattern: ^[ -~]{0,1000}$ Example: secret_password |
A password to protect the download. To download the file send the password in the x-oc-download-password header or set a cookie named x-oc-download-password. The value contains a comma separated list of passwords. |
embed_font
Type: string Enum: sans serif |
Embed generic font |
enable_heuristics
Type: boolean Default: False |
Enable heuristic processing |
encoding
Type: string Enum: 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
Type: string Enum: 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
Type: string Pattern: ^[\w\W]{0,255}$ Example: my_base_filename_without_extension |
The desired file name of the converted file WITHOUT the file extension. |
preset
Type: string Pattern: ^[\w\W]{1,255}$ |
Predefined options |
reader
Type: string Enum: 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
Type: string Pattern: ^[\w\W]{0,512}$ |
Change ebook title (up to 512 characters) |
version
Type: string Enum: 2 3 |
The format's version |
POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Oc-Api-Key: <your API key here>
Content-Type: application/json
{
"input": [{
"type": "remote",
"source": "https://example-files.online-convert.com/document/pdf/example.pdf"
}],
"conversion": [{
"category": "ebook",
"target": "epub",
"options": {
<conversion options here>
}
}]
}