Here are all available conversion options you can use in the "options" section of conversions (see the example JSON below the table).
Here are all available conversion options you can use in 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 |
|
|
disabled_categories
Type: string Pattern: ^[A-Z0-9_,]{1,1024}$ |
Comma separated list of category ids to disable. |
|
disabled_rules
Type: string Pattern: ^[A-Z0-9_,]{1,1024}$ |
Comma separated list of rule ids to disable. |
|
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-api2convert-download-password header or set a cookie named x-api2convert-download-password (the legacy x-oc-download-password header and cookie are still accepted). The value contains a comma separated list of passwords. |
|
enabled_categories
Type: string Pattern: ^[A-Z0-9_,]{1,1024}$ |
Comma separated list of category ids to enable. |
|
enabled_only
Type: boolean Default: False |
Check only the rules and categories listed in enabled_rules and enabled_categories. |
|
enabled_rules
Type: string Pattern: ^[A-Z0-9_,]{1,1024}$ |
Comma separated list of rule ids to enable. |
|
generate_format
Type: string Enum: json txt Default: json |
The output file format. "json" returns the list of matches, "txt" returns the auto-corrected text. |
|
ignore_words
Type: string Pattern: ^[\w\W]{0,4096}$ |
Comma separated list of words that must not be reported. |
|
language
Type: string Default: auto Enum: auto ar ast-ES be-BY br-FR ca-ES ca-ES-balear ca-ES-valencia crh-UA da-DK de de-AT de-CH de-DE de-DE-x-simple-language de-DE-x-simple-language-DE de-LU el-GR en en-AU en-CA en-GB en-NZ en-US en-ZA eo es es-AR es-ES fa fa-IR fr fr-BE fr-CA fr-CH fr-FR ga-IE gl-ES it it-IT ja-JP km-KH nl nl-BE nl-NL pl-PL pt pt-AO pt-BR pt-MZ pt-PT ro-RO ru-RU sk-SK sl-SI sv sv-SE ta-IN tl-PH uk-UA zh-CN |
The language of the text to check. Use "auto" to let the service detect it. |
|
level
Type: string Enum: default picky |
Use "picky" to also report style and semantic issues. |
|
mother_tongue
Type: string Enum: ar ast-ES be-BY br-FR ca-ES ca-ES-balear ca-ES-valencia crh-UA da-DK de de-AT de-CH de-DE de-DE-x-simple-language de-DE-x-simple-language-DE de-LU el-GR en en-AU en-CA en-GB en-NZ en-US en-ZA eo es es-AR es-ES fa fa-IR fr fr-BE fr-CA fr-CH fr-FR ga-IE gl-ES it it-IT ja-JP km-KH nl nl-BE nl-NL pl-PL pt pt-AO pt-BR pt-MZ pt-PT ro-RO ru-RU sk-SK sl-SI sv sv-SE ta-IN tl-PH uk-UA zh-CN |
Your native language. Enables detection of false friends. |
|
preferred_variants
Type: string Pattern: ^[a-zA-Z-,]{1,255}$ |
Comma separated list of preferred language variants. Only meaningful when language is "auto". |
POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Oc-Api-Key: <your API key here>
Content-Type: application/json
{
"input": [{
"type": "remote",
"source": "https://example-files.online-convert.com/raster%20image/png/example_small.png"
}],
"conversion": [{
"category": "operation",
"target": "spellcheck",
"options": {
<conversion options here>
}
}]
}