API Documentation
- Getting Started
- Libraries
- Authentication
- API URL
- API Requests
- API Response
- API Reference
- Step 1. Upload file to the server
- Step 2. Run conversion task
- Step 3. Get conversion task status
- Step 4. Download result file
- Available Conversion Types
- Need Help?
Getting Started
We provide access to the Conversion Tools services via the HTTP-based REST API using the token authentication. API request and response are formatted in JSON.
Libraries
We maintain the following official REST API Client libraries:
- conversiontools-node - Conversion Tools Node.js client
- conversiontools-python - Conversion Tools Python client
- conversiontools-php - Conversion Tools PHP client
Authentication
When account is created we generate the API Token for accessing the Conversion Tools REST API.
API Token can be found at your Profile.
API Token should be passed to HTTP request in the Authorization HTTP header with the Bearer authentication scheme as follows:
Authorization: Bearer <API Token>
The following sample request checking the access to the Conversion Tools REST API:
curl -sSX GET https://api.conversiontools.io/v1/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>"
API URL
Conversion Tools REST API is available at:
https://api.conversiontools.io/v1/API Requests
API Request should contain the following components:
- The HTTP method, one of
GETorPOST AuthorizationHTTP header with API TokenContent-TypeHTTP header with typeapplication/json- A JSON request body which depends on the API command, see list of API commands below
The folllowing sample API request creates new conversion task:
curl -sSX POST https://api.conversiontools.io/v1/tasks \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>" \
-d '{
"type": "convert.website_to_jpg",
"options": {
"url": "http://google.com",
"images": "yes"
}
}'
API Response
General format of the API response has error field and some optional <data>:
{
"error": "<error text>",
<data>
}In case of success, <error text> will be empty (null), for example:
{
"error": null,
"task_id": "4147c475ffe94ec8a11aff9a6a8f437a"
}In case of error, <error text> will contain the error description, for example:
{
"error": "Bad request"
}API Reference
File conversion process consists of the following 4 steps:
- Upload file to the server (optional step when URL is provided)
- Run conversion task
- Get conversion task status
- Download the result file
Step 1. Upload file to the Conversion Tools Server
In case when you providing the file by Internet URL - start with a Step 2.
For file upload use a HTTP POST file upload request with the Content-Type: multipart/form-data header.
See sample request below.
Request:
POST https://api.conversiontools.io/v1/filesHeaders:
Authorization: Bearer <API Token> |
Content-Type: multipart/form-data |
Input parameters:
file | (required) | A file reference |
Response:
Success response will contain file_id field, which contains the identifier of the uploaded file:
{
"error": null,
"file_id": "be87de1a680c4451a49a72df3fecd3fd"
}This file_id value should be used in the following step (Run conversion task).
Sample request using curl:
curl -sSX POST https://api.conversiontools.io/v1/files \
-H "Authorization: Bearer <API Token>" \
-F "file=@/home/user/Desktop/test.xml"
Please note: -F parameter of curl automatically adding header Content-Type: multipart/form-data to the request.
Step 2. Run conversion task
Request:
POST https://api.conversiontools.io/v1/tasksHeaders:
Authorization: Bearer <API Token> |
Content-Type: application/json |
Input parameters:
type | (required) | Conversion type, for example convert.website_to_pdf. See list of available conversion types. |
options | (required) | Set of options, different for every conversion task, see the tables below. |
options parameters generic for every conversion task:
file_id | (required, when converting the file uploaded to the server) | For conversions which require a file to be uploaded, this is the file_id returned by POST /files request (from Step 1). |
url | (required, when converting the file from the Internet by link) | For conversions which accepts file by URL, this is a place to put it. |
options parameters specific per conversion task:
Please click on the conversion type to see the list of available options.
convert.ocr_png_to_text - OCR: Convert PNG to Text Online - PNG to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_jpg_to_text - OCR: Convert JPG to Text Online - JPG to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_png_to_pdf - OCR: Convert PNG to PDF Online - PNG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_jpg_to_pdf - OCR: Convert JPG to PDF Online - JPG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_pdf_to_text - OCR: Convert PDF to Text Online - PDF to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_pdf_to_pdf - OCR: Convert PDF Image to PDF Text Online - PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.mp4_to_mp3 - Convert MP4 to MP3 Online - MP4 to MP3 Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
bitrate | (optional) | default 96 128 160 192 256 320 |
For optional parameters the default value highlighted in bold text. | ||
convert.wav_to_mp3 - Convert WAV to MP3 Online - WAV to MP3 Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
bitrate | (optional) | default 96 128 160 192 256 320 |
For optional parameters the default value highlighted in bold text. | ||
convert.flac_to_mp3 - Convert FLAC to MP3 Online - FLAC to MP3 Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
bitrate | (optional) | default 96 128 160 192 256 320 |
For optional parameters the default value highlighted in bold text. | ||
convert.mp3_to_wav - Convert MP3 to WAV Online - MP3 to WAV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
sampling_rate | (optional) | default 8000 16000 44100 48000 |
bit_depth | (optional) | 8 16 24 32 |
audio_channels | (optional) | default 1 2 |
For optional parameters the default value highlighted in bold text. | ||
convert.flac_to_wav - Convert FLAC to WAV Online - FLAC to WAV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
sampling_rate | (optional) | default 8000 16000 44100 48000 |
bit_depth | (optional) | 8 16 24 32 |
audio_channels | (optional) | default 1 2 |
For optional parameters the default value highlighted in bold text. | ||
convert.wav_to_flac - Convert WAV to FLAC Online - WAV to FLAC Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.website_to_pdf - Convert HTML to PDF Online - HTML to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required, when converting the uploaded file) | file_id of the file to convert |
url | (required, when converting the file from url) | Internet URL of the file to convert |
orientation | (optional) | Landscape Portrait |
pagesize | (optional) | A4 B5 Letter |
colormode | (optional) | colored grayscale |
background | (optional) | yes no |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.word_to_pdf - Convert Word to PDF Online - Word to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.powerpoint_to_pdf - Convert PowerPoint to PDF Online - PowerPoint to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.oxps_to_pdf - Convert OXPS to PDF Online - OXPS to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.word_to_text - Convert Word to Text Online - Word to TXT Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.powerpoint_to_text - Convert PowerPoint to Text Online - PowerPoint to TXT Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.jpg_to_pdf - Convert JPG to PDF Online - JPG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.png_to_pdf - Convert PNG to PDF Online - PNG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.markdown_to_pdf - Convert Markdown to PDF Online - Markdown to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.markdown_to_html - Convert Markdown to HTML Online - Markdown to HTML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.markdown_to_epub - Convert Markdown to ePUB Online - Markdown to ePUB Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.website_to_jpg - Convert Website to JPG. Create Website Thumbnail. Save Website as Image. HTML to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.html_to_jpg - Convert HTML to JPG. Save Website as JPG Image. HTML to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.website_to_png - Convert Website to PNG. Save Website as PNG Image. HTML to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.html_to_png - Convert HTML to PNG. Save Website as PNG Image. HTML to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.html_table_to_csv - Convert HTML Table to CSV Online - HTML to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required, when converting the uploaded file) | file_id of the file to convert |
url | (required, when converting the file from url) | Internet URL of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_pdf - Convert Excel to PDF Online - Excel to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_html - Convert Excel to HTML Online - Excel to HTML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
recalculate | (optional) | yes no |
title_overview | (optional) | Title for 'Overview' label |
title_sheet | (optional) | Title for 'Sheet X' label |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_csv - Convert Excel to CSV Online - Excel to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_ods - Convert Excel to ODS Online - Excel to OpenOffice Calc ODS Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.ods_to_csv - Convert OpenOffice Calc ODS to CSV Online - ODS to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
For optional parameters the default value highlighted in bold text. | ||
convert.ods_to_pdf - Convert OpenOffice Calc ODS to PDF Online - ODS to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.ods_to_excel - Convert OpenOffice Calc ODS to Excel Online - ODS to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.csv_to_excel - Convert CSV to Excel Online - CSV to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.csv_to_xml - Convert CSV to XML Online - CSV to XML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
header | (optional) | Use first line of the file as a columns header: yes no |
show_columns | (optional) | Add <columns /> section: yes no |
add_empty_nodes | (optional) | Add empty nodes (when no value present): yes no |
short_tag_empty_node | (optional) | Use short tag <node/> for empty nodes: yes no |
xml_encoding | (optional) | XML Encoding (output file): utf-8 utf-16le utf-16be |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_xml - Convert Excel to XML Online - Excel to XML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
header | (optional) | Use first line of the file as a columns header: yes no |
show_columns | (optional) | Add <columns /> section: yes no |
add_empty_nodes | (optional) | Add empty nodes (when no value present): yes no |
short_tag_empty_node | (optional) | Use short tag <node/> for empty nodes: yes no |
xml_encoding | (optional) | XML Encoding (output file): utf-8 utf-16le utf-16be |
For optional parameters the default value highlighted in bold text. | ||
convert.xml_to_json - Convert XML to JSON Online - XML to JSON Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.xml_to_csv - Convert XML to CSV Online - XML to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.xml_to_excel - Convert XML to Excel Online - XML to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
split_excel_rows_limit | (optional) | yes no |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_xml_to_excel_xlsx - Convert Excel XML to Excel XLSX Online - Excel XML to XLSX Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_csv - Convert PDF to CSV Online - PDF to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_excel - Convert PDF to Excel Online - PDF to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_jpg - Convert PDF to JPG Online - PDF to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
jpeg_quality | (optional) | 0 - 100 (default: 80) |
colormode | (optional) | colored grayscale |
progressive_jpeg | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_png - Convert PDF to PNG Online - PDF to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
colormode3 | (optional) | colored grayscale monochrome |
background_color | (optional) | white transparent |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_tiff - Convert PDF to TIFF Online - PDF to TIFF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
colormode3 | (optional) | colored grayscale monochrome |
background_color | (optional) | white transparent |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_svg - Convert PDF to SVG Online - PDF to SVG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
pagesize | (optional) | A4 B5 Letter |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_html - Convert PDF to HTML Online - PDF to HTML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_text - Convert PDF to Text Online - PDF to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.png_to_jpg - Convert PNG to JPG Online - PNG to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.jpg_to_png - Convert JPG to PNG Online - JPG to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.heic_to_png - Convert HEIC to PNG Online - HEIC to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.heic_to_jpg - Convert HEIC to JPG Online - HEIC to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
jpeg_quality | (optional) | 0 - 100 (default: 80) |
For optional parameters the default value highlighted in bold text. | ||
convert.png_to_webp - Convert PNG to WebP Online - PNG to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.jpg_to_webp - Convert JPG to WebP Online - JPG to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.tiff_to_webp - Convert TIFF to WebP Online - TIFF to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.gif_to_webp - Convert GIF to WebP Online - GIF to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_png - Convert WebP to PNG Online - WebP to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_tiff - Convert WebP to TIFF Online - WebP to TIFF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_bmp - Convert WebP to BMP Online - WebP to BMP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_yuv - Convert WebP to YUV Online - WebP to YUV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_pam - Convert WebP to PAM Online - WebP to PAM Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_pgm - Convert WebP to PGM Online - WebP to PGM Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_ppm - Convert WebP to PPM Online - WebP to PPM Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.epub_to_mobi - Convert ePUB to MOBI Online - ePUB to MOBI Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.epub_to_azw - Convert ePUB to AZW Online - ePUB to AZW Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.mobi_to_epub - Convert MOBI to ePUB Online - MOBI to ePUB Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.mobi_to_azw - Convert MOBI to AZW Online - MOBI to AZW Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw_to_epub - Convert AZW to ePUB Online - AZW to ePUB Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw_to_mobi - Convert AZW to MOBI Online - AZW to MOBI Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.epub_to_pdf - Convert ePUB to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.mobi_to_pdf - Convert MOBI to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw_to_pdf - Convert AZW to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw3_to_pdf - Convert AZW3 to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.fb2_to_pdf - Convert FB2 to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.fbz_to_pdf - Convert FBZ to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_epub - Convert PDF to ePUB Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_mobi - Convert PDF to MOBI Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_azw - Convert PDF to AZW Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_azw3 - Convert PDF to AZW3 Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_fb2 - Convert PDF to FB2 Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_fbz - Convert PDF to FBZ Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.remove_exif - Remove EXIF Data from Photos Online| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.format_json - JSON Formatter Online - Format JSON file| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.validate_json - JSON Validator Online - Validate JSON file| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_xml - Convert JSON to XML Online - JSON to XML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_csv - Convert JSON to CSV Online - JSON to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_excel - Convert JSON to Excel Online - JSON to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_yaml - Convert JSON to YAML Online - JSON to YAML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.json_objects_to_csv - Convert JSON objects (one per line) to CSV Online - JSON to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.json_objects_to_excel - Convert JSON objects (one per line) to Excel Online - JSON to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.yaml_to_json - Convert YAML to JSON Online - YAML to JSON Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.srt_to_csv - Convert SRT to CSV Online - SRT to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.srt_to_excel - Convert SRT to Excel Online - SRT to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
The folllowing sample API request creates new conversion task:
curl -sSX POST https://api.conversiontools.io/v1/tasks \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>" \
-d '{
"type": "convert.website_to_jpg",
"options": {
"url": "http://google.com",
"images": "yes"
}
}'
Response:
{
"error": "<error text>",
"task_id": "<task_id>"
}In case of error, <error text> will be any not null text value, it will contain the description of error.
{
"error": "Bad type",
}In case of success, it will return <task_id>. You should use Get conversion task status request to find out when conversion task will be finished.
{
"error": null,
"task_id": "4147c475ffe94ec8a11aff9a6a8f437a"
}Step 3. Get conversion task status
You should perform this check in a loop, until task will be finished (see status field).
Important! Please send this request not more often than every 5-10 seconds.
Request:
GET https://api.conversiontools.io/v1/tasks/<task_id>Headers:
Authorization: Bearer <API Token> |
Content-Type: application/json |
URL parameters:
task_id | (required) | This is the task_id returned in the previous step. |
The folllowing sample API request check the conversion task status:
curl -sSX GET https://api.conversiontools.io/v1/tasks/d9b5369bfc6541d88581d4ff80954917 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>"
Response:
{
"error": "<error text>",
"status": "<status>",
"file_id": "<file_id>"
}In case of error, <error text> will be any not null text value, it will contain the description of error.
status is one of the following:
PENDING- task is queued and waiting to be processedRUNNING- task is runningSUCCESS- task is finished successfullyERROR- task is finished with an error
When status is PENDING or RUNNING, response will have an empty file_id field, for example:
{
"error": null,
"status": "RUNNING",
"file_id": null
}When status is SUCCESS, response will have file_id of the result file, for example:
{
"error": null,
"status": "SUCCESS",
"file_id": "ce87de1a680c4451a49a72df3fecd3fe"
}When status is ERROR, response will have error field with description of the error:
{
"error": "Wrong file format",
"status": "ERROR",
"file_id": null
}When status returned as SUCCESS or ERROR - this means that the conversion process is finished and you can download the result file using file_id (request is described in the next step) or analyse the error.
Step 4. Download result file
Request:
GET https://api.conversiontools.io/v1/files/<file_id>Headers:
Authorization: Bearer <API Token> |
Content-Type: application/json |
URL parameters:
<file_id> | (required) | This is the file_id of the file you need to download, for example, file_id returned in the previous step get task status. |
Response:
The response will contain a Content-Disposition: attachment; HTTP header, which should trigger the file download process (if you're using a browser).
Available Conversion Types
| Conversion Type | Description |
|---|---|
convert.ocr_png_to_text | OCR: Convert PNG to Text Online - PNG to Text Converter |
convert.ocr_jpg_to_text | OCR: Convert JPG to Text Online - JPG to Text Converter |
convert.ocr_png_to_pdf | OCR: Convert PNG to PDF Online - PNG to PDF Converter |
convert.ocr_jpg_to_pdf | OCR: Convert JPG to PDF Online - JPG to PDF Converter |
convert.ocr_pdf_to_text | OCR: Convert PDF to Text Online - PDF to Text Converter |
convert.ocr_pdf_to_pdf | OCR: Convert PDF Image to PDF Text Online - PDF Converter |
convert.mp4_to_mp3 | Convert MP4 to MP3 Online - MP4 to MP3 Converter |
convert.wav_to_mp3 | Convert WAV to MP3 Online - WAV to MP3 Converter |
convert.flac_to_mp3 | Convert FLAC to MP3 Online - FLAC to MP3 Converter |
convert.mp3_to_wav | Convert MP3 to WAV Online - MP3 to WAV Converter |
convert.flac_to_wav | Convert FLAC to WAV Online - FLAC to WAV Converter |
convert.wav_to_flac | Convert WAV to FLAC Online - WAV to FLAC Converter |
convert.website_to_pdf | Convert HTML to PDF Online - HTML to PDF Converter |
convert.word_to_pdf | Convert Word to PDF Online - Word to PDF Converter |
convert.powerpoint_to_pdf | Convert PowerPoint to PDF Online - PowerPoint to PDF Converter |
convert.oxps_to_pdf | Convert OXPS to PDF Online - OXPS to PDF Converter |
convert.word_to_text | Convert Word to Text Online - Word to TXT Converter |
convert.powerpoint_to_text | Convert PowerPoint to Text Online - PowerPoint to TXT Converter |
convert.jpg_to_pdf | Convert JPG to PDF Online - JPG to PDF Converter |
convert.png_to_pdf | Convert PNG to PDF Online - PNG to PDF Converter |
convert.markdown_to_pdf | Convert Markdown to PDF Online - Markdown to PDF Converter |
convert.markdown_to_html | Convert Markdown to HTML Online - Markdown to HTML Converter |
convert.markdown_to_epub | Convert Markdown to ePUB Online - Markdown to ePUB Converter |
convert.website_to_jpg | Convert Website to JPG. Create Website Thumbnail. Save Website as Image. HTML to JPG Converter |
convert.html_to_jpg | Convert HTML to JPG. Save Website as JPG Image. HTML to JPG Converter |
convert.website_to_png | Convert Website to PNG. Save Website as PNG Image. HTML to PNG Converter |
convert.html_to_png | Convert HTML to PNG. Save Website as PNG Image. HTML to PNG Converter |
convert.html_table_to_csv | Convert HTML Table to CSV Online - HTML to CSV Converter |
convert.excel_to_pdf | Convert Excel to PDF Online - Excel to PDF Converter |
convert.excel_to_html | Convert Excel to HTML Online - Excel to HTML Converter |
convert.excel_to_csv | Convert Excel to CSV Online - Excel to CSV Converter |
convert.excel_to_ods | Convert Excel to ODS Online - Excel to OpenOffice Calc ODS Converter |
convert.ods_to_csv | Convert OpenOffice Calc ODS to CSV Online - ODS to CSV Converter |
convert.ods_to_pdf | Convert OpenOffice Calc ODS to PDF Online - ODS to PDF Converter |
convert.ods_to_excel | Convert OpenOffice Calc ODS to Excel Online - ODS to Excel Converter |
convert.csv_to_excel | Convert CSV to Excel Online - CSV to Excel Converter |
convert.csv_to_xml | Convert CSV to XML Online - CSV to XML Converter |
convert.excel_to_xml | Convert Excel to XML Online - Excel to XML Converter |
convert.xml_to_json | Convert XML to JSON Online - XML to JSON Converter |
convert.xml_to_csv | Convert XML to CSV Online - XML to CSV Converter |
convert.xml_to_excel | Convert XML to Excel Online - XML to Excel Converter |
convert.excel_xml_to_excel_xlsx | Convert Excel XML to Excel XLSX Online - Excel XML to XLSX Converter |
convert.pdf_to_csv | Convert PDF to CSV Online - PDF to CSV Converter |
convert.pdf_to_excel | Convert PDF to Excel Online - PDF to Excel Converter |
convert.pdf_to_jpg | Convert PDF to JPG Online - PDF to JPG Converter |
convert.pdf_to_png | Convert PDF to PNG Online - PDF to PNG Converter |
convert.pdf_to_tiff | Convert PDF to TIFF Online - PDF to TIFF Converter |
convert.pdf_to_svg | Convert PDF to SVG Online - PDF to SVG Converter |
convert.pdf_to_html | Convert PDF to HTML Online - PDF to HTML Converter |
convert.pdf_to_text | Convert PDF to Text Online - PDF to Text Converter |
convert.png_to_jpg | Convert PNG to JPG Online - PNG to JPG Converter |
convert.jpg_to_png | Convert JPG to PNG Online - JPG to PNG Converter |
convert.heic_to_png | Convert HEIC to PNG Online - HEIC to PNG Converter |
convert.heic_to_jpg | Convert HEIC to JPG Online - HEIC to JPG Converter |
convert.png_to_webp | Convert PNG to WebP Online - PNG to WebP Converter |
convert.jpg_to_webp | Convert JPG to WebP Online - JPG to WebP Converter |
convert.tiff_to_webp | Convert TIFF to WebP Online - TIFF to WebP Converter |
convert.gif_to_webp | Convert GIF to WebP Online - GIF to WebP Converter |
convert.webp_to_png | Convert WebP to PNG Online - WebP to PNG Converter |
convert.webp_to_tiff | Convert WebP to TIFF Online - WebP to TIFF Converter |
convert.webp_to_bmp | Convert WebP to BMP Online - WebP to BMP Converter |
convert.webp_to_yuv | Convert WebP to YUV Online - WebP to YUV Converter |
convert.webp_to_pam | Convert WebP to PAM Online - WebP to PAM Converter |
convert.webp_to_pgm | Convert WebP to PGM Online - WebP to PGM Converter |
convert.webp_to_ppm | Convert WebP to PPM Online - WebP to PPM Converter |
convert.epub_to_mobi | Convert ePUB to MOBI Online - ePUB to MOBI Converter |
convert.epub_to_azw | Convert ePUB to AZW Online - ePUB to AZW Converter |
convert.mobi_to_epub | Convert MOBI to ePUB Online - MOBI to ePUB Converter |
convert.mobi_to_azw | Convert MOBI to AZW Online - MOBI to AZW Converter |
convert.azw_to_epub | Convert AZW to ePUB Online - AZW to ePUB Converter |
convert.azw_to_mobi | Convert AZW to MOBI Online - AZW to MOBI Converter |
convert.epub_to_pdf | Convert ePUB to PDF Online - eBook to PDF Converter |
convert.mobi_to_pdf | Convert MOBI to PDF Online - eBook to PDF Converter |
convert.azw_to_pdf | Convert AZW to PDF Online - eBook to PDF Converter |
convert.azw3_to_pdf | Convert AZW3 to PDF Online - eBook to PDF Converter |
convert.fb2_to_pdf | Convert FB2 to PDF Online - eBook to PDF Converter |
convert.fbz_to_pdf | Convert FBZ to PDF Online - eBook to PDF Converter |
convert.pdf_to_epub | Convert PDF to ePUB Online - PDF to eBook Converter |
convert.pdf_to_mobi | Convert PDF to MOBI Online - PDF to eBook Converter |
convert.pdf_to_azw | Convert PDF to AZW Online - PDF to eBook Converter |
convert.pdf_to_azw3 | Convert PDF to AZW3 Online - PDF to eBook Converter |
convert.pdf_to_fb2 | Convert PDF to FB2 Online - PDF to eBook Converter |
convert.pdf_to_fbz | Convert PDF to FBZ Online - PDF to eBook Converter |
convert.remove_exif | Remove EXIF Data from Photos Online |
convert.format_json | JSON Formatter Online - Format JSON file |
convert.validate_json | JSON Validator Online - Validate JSON file |
convert.json_to_xml | Convert JSON to XML Online - JSON to XML Converter |
convert.json_to_csv | Convert JSON to CSV Online - JSON to CSV Converter |
convert.json_to_excel | Convert JSON to Excel Online - JSON to Excel Converter |
convert.json_to_yaml | Convert JSON to YAML Online - JSON to YAML Converter |
convert.json_objects_to_csv | Convert JSON objects (one per line) to CSV Online - JSON to CSV Converter |
convert.json_objects_to_excel | Convert JSON objects (one per line) to Excel Online - JSON to Excel Converter |
convert.yaml_to_json | Convert YAML to JSON Online - YAML to JSON Converter |
convert.srt_to_csv | Convert SRT to CSV Online - SRT to CSV Converter |
convert.srt_to_excel | Convert SRT to Excel Online - SRT to Excel Converter |
Need help?
If you have any questions regarding the use of the Conversion Tools REST API - feel free to contact us.
API Documentation
- Getting Started
- Libraries
- Authentication
- API URL
- API Requests
- API Response
- API Reference
- Step 1. Upload file to the server
- Step 2. Run conversion task
- Step 3. Get conversion task status
- Step 4. Download result file
- Available Conversion Types
- Need Help?
Getting Started
We provide access to the Conversion Tools services via the HTTP-based REST API using the token authentication. API request and response are formatted in JSON.
Libraries
We maintain the following official REST API Client libraries:
- conversiontools-node - Conversion Tools Node.js client
- conversiontools-python - Conversion Tools Python client
- conversiontools-php - Conversion Tools PHP client
Authentication
When account is created we generate the API Token for accessing the Conversion Tools REST API.
API Token can be found at your Profile.
API Token should be passed to HTTP request in the Authorization HTTP header with the Bearer authentication scheme as follows:
Authorization: Bearer <API Token>
The following sample request checking the access to the Conversion Tools REST API:
curl -sSX GET https://api.conversiontools.io/v1/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>"
API URL
Conversion Tools REST API is available at:
https://api.conversiontools.io/v1/API Requests
API Request should contain the following components:
- The HTTP method, one of
GETorPOST AuthorizationHTTP header with API TokenContent-TypeHTTP header with typeapplication/json- A JSON request body which depends on the API command, see list of API commands below
The folllowing sample API request creates new conversion task:
curl -sSX POST https://api.conversiontools.io/v1/tasks \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>" \
-d '{
"type": "convert.website_to_jpg",
"options": {
"url": "http://google.com",
"images": "yes"
}
}'
API Response
General format of the API response has error field and some optional <data>:
{
"error": "<error text>",
<data>
}In case of success, <error text> will be empty (null), for example:
{
"error": null,
"task_id": "4147c475ffe94ec8a11aff9a6a8f437a"
}In case of error, <error text> will contain the error description, for example:
{
"error": "Bad request"
}API Reference
File conversion process consists of the following 4 steps:
- Upload file to the server (optional step when URL is provided)
- Run conversion task
- Get conversion task status
- Download the result file
Step 1. Upload file to the Conversion Tools Server
In case when you providing the file by Internet URL - start with a Step 2.
For file upload use a HTTP POST file upload request with the Content-Type: multipart/form-data header.
See sample request below.
Request:
POST https://api.conversiontools.io/v1/filesHeaders:
Authorization: Bearer <API Token> |
Content-Type: multipart/form-data |
Input parameters:
file | (required) | A file reference |
Response:
Success response will contain file_id field, which contains the identifier of the uploaded file:
{
"error": null,
"file_id": "be87de1a680c4451a49a72df3fecd3fd"
}This file_id value should be used in the following step (Run conversion task).
Sample request using curl:
curl -sSX POST https://api.conversiontools.io/v1/files \
-H "Authorization: Bearer <API Token>" \
-F "file=@/home/user/Desktop/test.xml"
Please note: -F parameter of curl automatically adding header Content-Type: multipart/form-data to the request.
Step 2. Run conversion task
Request:
POST https://api.conversiontools.io/v1/tasksHeaders:
Authorization: Bearer <API Token> |
Content-Type: application/json |
Input parameters:
type | (required) | Conversion type, for example convert.website_to_pdf. See list of available conversion types. |
options | (required) | Set of options, different for every conversion task, see the tables below. |
options parameters generic for every conversion task:
file_id | (required, when converting the file uploaded to the server) | For conversions which require a file to be uploaded, this is the file_id returned by POST /files request (from Step 1). |
url | (required, when converting the file from the Internet by link) | For conversions which accepts file by URL, this is a place to put it. |
options parameters specific per conversion task:
Please click on the conversion type to see the list of available options.
convert.ocr_png_to_text - OCR: Convert PNG to Text Online - PNG to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_jpg_to_text - OCR: Convert JPG to Text Online - JPG to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_png_to_pdf - OCR: Convert PNG to PDF Online - PNG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_jpg_to_pdf - OCR: Convert JPG to PDF Online - JPG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_pdf_to_text - OCR: Convert PDF to Text Online - PDF to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.ocr_pdf_to_pdf - OCR: Convert PDF Image to PDF Text Online - PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
language_ocr | (optional) | Languages used on the image for OCR For multiple values - separate values with comma: eng,fra afr - Afrikaans amh - Amharic ara - Arabic asm - Assamese aze - Azerbaijani aze_cyrl - Azerbaijani - Cyrilic bel - Belarusian ben - Bengali bod - Tibetan bos - Bosnian bre - Breton bul - Bulgarian cat - Catalan; Valencian ceb - Cebuano ces - Czech chi_sim - Chinese - Simplified chi_tra - Chinese - Traditional chr - Cherokee cos - Corsican cym - Welsh dan - Danish dan_frak - Danish - Fraktur deu - German deu_frak - German - Fraktur dzo - Dzongkha ell - Greek, Modern (1453-) eng - English enm - English, Middle (1100-1500) epo - Esperanto est - Estonian eus - Basque fao - Faroese fas - Persian fil - Filipino (old - Tagalog) fin - Finnish fra - French frk - German - Fraktur frm - French, Middle (ca.1400-1600) fry - Western Frisian gla - Scottish Gaelic gle - Irish glg - Galician grc - Greek, Ancient (to 1453) guj - Gujarati hat - Haitian; Haitian Creole heb - Hebrew hin - Hindi hrv - Croatian hun - Hungarian hye - Armenian iku - Inuktitut ind - Indonesian isl - Icelandic ita - Italian ita_old - Italian - Old jav - Javanese jpn - Japanese kan - Kannada kat - Georgian kat_old - Georgian - Old kaz - Kazakh khm - Central Khmer kir - Kirghiz; Kyrgyz kmr - Kurmanji (Kurdish - Latin Script) kor - Korean kor_vert - Korean (vertical) kur - Kurdish (Arabic Script) lao - Lao lat - Latin lav - Latvian lit - Lithuanian ltz - Luxembourgish mal - Malayalam mar - Marathi mkd - Macedonian mlt - Maltese mon - Mongolian mri - Maori msa - Malay mya - Burmese nep - Nepali nld - Dutch; Flemish nor - Norwegian oci - Occitan (post 1500) ori - Oriya osd - Orientation and script detection module pan - Panjabi; Punjabi pol - Polish por - Portuguese pus - Pushto; Pashto que - Quechua ron - Romanian; Moldavian; Moldovan rus - Russian san - Sanskrit sin - Sinhala; Sinhalese slk - Slovak slk_frak - Slovak - Fraktur slv - Slovenian snd - Sindhi spa - Spanish; Castilian spa_old - Spanish; Castilian - Old sqi - Albanian srp - Serbian srp_latn - Serbian - Latin sun - Sundanese swa - Swahili swe - Swedish syr - Syriac tam - Tamil tat - Tatar tel - Telugu tgk - Tajik tgl - Tagalog (new - Filipino) tha - Thai tir - Tigrinya ton - Tonga tur - Turkish uig - Uighur; Uyghur ukr - Ukrainian urd - Urdu uzb - Uzbek uzb_cyrl - Uzbek - Cyrilic vie - Vietnamese yid - Yiddish yor - Yoruba |
For optional parameters the default value highlighted in bold text. | ||
convert.mp4_to_mp3 - Convert MP4 to MP3 Online - MP4 to MP3 Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
bitrate | (optional) | default 96 128 160 192 256 320 |
For optional parameters the default value highlighted in bold text. | ||
convert.wav_to_mp3 - Convert WAV to MP3 Online - WAV to MP3 Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
bitrate | (optional) | default 96 128 160 192 256 320 |
For optional parameters the default value highlighted in bold text. | ||
convert.flac_to_mp3 - Convert FLAC to MP3 Online - FLAC to MP3 Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
bitrate | (optional) | default 96 128 160 192 256 320 |
For optional parameters the default value highlighted in bold text. | ||
convert.mp3_to_wav - Convert MP3 to WAV Online - MP3 to WAV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
sampling_rate | (optional) | default 8000 16000 44100 48000 |
bit_depth | (optional) | 8 16 24 32 |
audio_channels | (optional) | default 1 2 |
For optional parameters the default value highlighted in bold text. | ||
convert.flac_to_wav - Convert FLAC to WAV Online - FLAC to WAV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
sampling_rate | (optional) | default 8000 16000 44100 48000 |
bit_depth | (optional) | 8 16 24 32 |
audio_channels | (optional) | default 1 2 |
For optional parameters the default value highlighted in bold text. | ||
convert.wav_to_flac - Convert WAV to FLAC Online - WAV to FLAC Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.website_to_pdf - Convert HTML to PDF Online - HTML to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required, when converting the uploaded file) | file_id of the file to convert |
url | (required, when converting the file from url) | Internet URL of the file to convert |
orientation | (optional) | Landscape Portrait |
pagesize | (optional) | A4 B5 Letter |
colormode | (optional) | colored grayscale |
background | (optional) | yes no |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.word_to_pdf - Convert Word to PDF Online - Word to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.powerpoint_to_pdf - Convert PowerPoint to PDF Online - PowerPoint to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.oxps_to_pdf - Convert OXPS to PDF Online - OXPS to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.word_to_text - Convert Word to Text Online - Word to TXT Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.powerpoint_to_text - Convert PowerPoint to Text Online - PowerPoint to TXT Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.jpg_to_pdf - Convert JPG to PDF Online - JPG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.png_to_pdf - Convert PNG to PDF Online - PNG to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.markdown_to_pdf - Convert Markdown to PDF Online - Markdown to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.markdown_to_html - Convert Markdown to HTML Online - Markdown to HTML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.markdown_to_epub - Convert Markdown to ePUB Online - Markdown to ePUB Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.website_to_jpg - Convert Website to JPG. Create Website Thumbnail. Save Website as Image. HTML to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.html_to_jpg - Convert HTML to JPG. Save Website as JPG Image. HTML to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.website_to_png - Convert Website to PNG. Save Website as PNG Image. HTML to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.html_to_png - Convert HTML to PNG. Save Website as PNG Image. HTML to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
url | (required) | Internet URL of the file to convert |
images | (optional) | yes no |
javascript | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.html_table_to_csv - Convert HTML Table to CSV Online - HTML to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required, when converting the uploaded file) | file_id of the file to convert |
url | (required, when converting the file from url) | Internet URL of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_pdf - Convert Excel to PDF Online - Excel to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_html - Convert Excel to HTML Online - Excel to HTML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
recalculate | (optional) | yes no |
title_overview | (optional) | Title for 'Overview' label |
title_sheet | (optional) | Title for 'Sheet X' label |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_csv - Convert Excel to CSV Online - Excel to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_ods - Convert Excel to ODS Online - Excel to OpenOffice Calc ODS Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.ods_to_csv - Convert OpenOffice Calc ODS to CSV Online - ODS to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
For optional parameters the default value highlighted in bold text. | ||
convert.ods_to_pdf - Convert OpenOffice Calc ODS to PDF Online - ODS to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
orientation | (optional) | Landscape Portrait |
For optional parameters the default value highlighted in bold text. | ||
convert.ods_to_excel - Convert OpenOffice Calc ODS to Excel Online - ODS to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.csv_to_excel - Convert CSV to Excel Online - CSV to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.csv_to_xml - Convert CSV to XML Online - CSV to XML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
header | (optional) | Use first line of the file as a columns header: yes no |
show_columns | (optional) | Add <columns /> section: yes no |
add_empty_nodes | (optional) | Add empty nodes (when no value present): yes no |
short_tag_empty_node | (optional) | Use short tag <node/> for empty nodes: yes no |
xml_encoding | (optional) | XML Encoding (output file): utf-8 utf-16le utf-16be |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_to_xml - Convert Excel to XML Online - Excel to XML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
header | (optional) | Use first line of the file as a columns header: yes no |
show_columns | (optional) | Add <columns /> section: yes no |
add_empty_nodes | (optional) | Add empty nodes (when no value present): yes no |
short_tag_empty_node | (optional) | Use short tag <node/> for empty nodes: yes no |
xml_encoding | (optional) | XML Encoding (output file): utf-8 utf-16le utf-16be |
For optional parameters the default value highlighted in bold text. | ||
convert.xml_to_json - Convert XML to JSON Online - XML to JSON Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.xml_to_csv - Convert XML to CSV Online - XML to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.xml_to_excel - Convert XML to Excel Online - XML to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
split_excel_rows_limit | (optional) | yes no |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.excel_xml_to_excel_xlsx - Convert Excel XML to Excel XLSX Online - Excel XML to XLSX Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_csv - Convert PDF to CSV Online - PDF to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_excel - Convert PDF to Excel Online - PDF to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_jpg - Convert PDF to JPG Online - PDF to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
jpeg_quality | (optional) | 0 - 100 (default: 80) |
colormode | (optional) | colored grayscale |
progressive_jpeg | (optional) | yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_png - Convert PDF to PNG Online - PDF to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
colormode3 | (optional) | colored grayscale monochrome |
background_color | (optional) | white transparent |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_tiff - Convert PDF to TIFF Online - PDF to TIFF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
colormode3 | (optional) | colored grayscale monochrome |
background_color | (optional) | white transparent |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_svg - Convert PDF to SVG Online - PDF to SVG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
image_resolution | (optional) | values in PPI (pixel per inch): 72 150 300 600 |
pagesize | (optional) | A4 B5 Letter |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_html - Convert PDF to HTML Online - PDF to HTML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_text - Convert PDF to Text Online - PDF to Text Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.png_to_jpg - Convert PNG to JPG Online - PNG to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.jpg_to_png - Convert JPG to PNG Online - JPG to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.heic_to_png - Convert HEIC to PNG Online - HEIC to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.heic_to_jpg - Convert HEIC to JPG Online - HEIC to JPG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
jpeg_quality | (optional) | 0 - 100 (default: 80) |
For optional parameters the default value highlighted in bold text. | ||
convert.png_to_webp - Convert PNG to WebP Online - PNG to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.jpg_to_webp - Convert JPG to WebP Online - JPG to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.tiff_to_webp - Convert TIFF to WebP Online - TIFF to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.gif_to_webp - Convert GIF to WebP Online - GIF to WebP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
webp_quality | (optional) | 0 - 100 (default: 75) |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_png - Convert WebP to PNG Online - WebP to PNG Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_tiff - Convert WebP to TIFF Online - WebP to TIFF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_bmp - Convert WebP to BMP Online - WebP to BMP Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_yuv - Convert WebP to YUV Online - WebP to YUV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_pam - Convert WebP to PAM Online - WebP to PAM Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_pgm - Convert WebP to PGM Online - WebP to PGM Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.webp_to_ppm - Convert WebP to PPM Online - WebP to PPM Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.epub_to_mobi - Convert ePUB to MOBI Online - ePUB to MOBI Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.epub_to_azw - Convert ePUB to AZW Online - ePUB to AZW Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.mobi_to_epub - Convert MOBI to ePUB Online - MOBI to ePUB Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.mobi_to_azw - Convert MOBI to AZW Online - MOBI to AZW Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw_to_epub - Convert AZW to ePUB Online - AZW to ePUB Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw_to_mobi - Convert AZW to MOBI Online - AZW to MOBI Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.epub_to_pdf - Convert ePUB to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.mobi_to_pdf - Convert MOBI to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw_to_pdf - Convert AZW to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.azw3_to_pdf - Convert AZW3 to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.fb2_to_pdf - Convert FB2 to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.fbz_to_pdf - Convert FBZ to PDF Online - eBook to PDF Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_epub - Convert PDF to ePUB Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_mobi - Convert PDF to MOBI Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_azw - Convert PDF to AZW Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_azw3 - Convert PDF to AZW3 Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_fb2 - Convert PDF to FB2 Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.pdf_to_fbz - Convert PDF to FBZ Online - PDF to eBook Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.remove_exif - Remove EXIF Data from Photos Online| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.format_json - JSON Formatter Online - Format JSON file| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.validate_json - JSON Validator Online - Validate JSON file| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_xml - Convert JSON to XML Online - JSON to XML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_csv - Convert JSON to CSV Online - JSON to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_excel - Convert JSON to Excel Online - JSON to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.json_to_yaml - Convert JSON to YAML Online - JSON to YAML Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
For optional parameters the default value highlighted in bold text. | ||
convert.json_objects_to_csv - Convert JSON objects (one per line) to CSV Online - JSON to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.json_objects_to_excel - Convert JSON objects (one per line) to Excel Online - JSON to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
convert.yaml_to_json - Convert YAML to JSON Online - YAML to JSON Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
space | (optional) | 0 1s 2s 3s 4s 1t |
For optional parameters the default value highlighted in bold text. | ||
convert.srt_to_csv - Convert SRT to CSV Online - SRT to CSV Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
delimiter | (optional) | comma semicolon vertical_bar tabulation |
quote | (optional) | Always quote all non-empty fields: yes no |
For optional parameters the default value highlighted in bold text. | ||
convert.srt_to_excel - Convert SRT to Excel Online - SRT to Excel Converter| Parameter | Required | Possible values |
|---|---|---|
file_id | (required) | file_id of the file to convert |
excel_format | (optional) | xlsx xls |
For optional parameters the default value highlighted in bold text. | ||
The folllowing sample API request creates new conversion task:
curl -sSX POST https://api.conversiontools.io/v1/tasks \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>" \
-d '{
"type": "convert.website_to_jpg",
"options": {
"url": "http://google.com",
"images": "yes"
}
}'
Response:
{
"error": "<error text>",
"task_id": "<task_id>"
}In case of error, <error text> will be any not null text value, it will contain the description of error.
{
"error": "Bad type",
}In case of success, it will return <task_id>. You should use Get conversion task status request to find out when conversion task will be finished.
{
"error": null,
"task_id": "4147c475ffe94ec8a11aff9a6a8f437a"
}Step 3. Get conversion task status
You should perform this check in a loop, until task will be finished (see status field).
Important! Please send this request not more often than every 5-10 seconds.
Request:
GET https://api.conversiontools.io/v1/tasks/<task_id>Headers:
Authorization: Bearer <API Token> |
Content-Type: application/json |
URL parameters:
task_id | (required) | This is the task_id returned in the previous step. |
The folllowing sample API request check the conversion task status:
curl -sSX GET https://api.conversiontools.io/v1/tasks/d9b5369bfc6541d88581d4ff80954917 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Token>"
Response:
{
"error": "<error text>",
"status": "<status>",
"file_id": "<file_id>"
}In case of error, <error text> will be any not null text value, it will contain the description of error.
status is one of the following:
PENDING- task is queued and waiting to be processedRUNNING- task is runningSUCCESS- task is finished successfullyERROR- task is finished with an error
When status is PENDING or RUNNING, response will have an empty file_id field, for example:
{
"error": null,
"status": "RUNNING",
"file_id": null
}When status is SUCCESS, response will have file_id of the result file, for example:
{
"error": null,
"status": "SUCCESS",
"file_id": "ce87de1a680c4451a49a72df3fecd3fe"
}When status is ERROR, response will have error field with description of the error:
{
"error": "Wrong file format",
"status": "ERROR",
"file_id": null
}When status returned as SUCCESS or ERROR - this means that the conversion process is finished and you can download the result file using file_id (request is described in the next step) or analyse the error.
Step 4. Download result file
Request:
GET https://api.conversiontools.io/v1/files/<file_id>Headers:
Authorization: Bearer <API Token> |
Content-Type: application/json |
URL parameters:
<file_id> | (required) | This is the file_id of the file you need to download, for example, file_id returned in the previous step get task status. |
Response:
The response will contain a Content-Disposition: attachment; HTTP header, which should trigger the file download process (if you're using a browser).
Available Conversion Types
| Conversion Type | Description |
|---|---|
convert.ocr_png_to_text | OCR: Convert PNG to Text Online - PNG to Text Converter |
convert.ocr_jpg_to_text | OCR: Convert JPG to Text Online - JPG to Text Converter |
convert.ocr_png_to_pdf | OCR: Convert PNG to PDF Online - PNG to PDF Converter |
convert.ocr_jpg_to_pdf | OCR: Convert JPG to PDF Online - JPG to PDF Converter |
convert.ocr_pdf_to_text | OCR: Convert PDF to Text Online - PDF to Text Converter |
convert.ocr_pdf_to_pdf | OCR: Convert PDF Image to PDF Text Online - PDF Converter |
convert.mp4_to_mp3 | Convert MP4 to MP3 Online - MP4 to MP3 Converter |
convert.wav_to_mp3 | Convert WAV to MP3 Online - WAV to MP3 Converter |
convert.flac_to_mp3 | Convert FLAC to MP3 Online - FLAC to MP3 Converter |
convert.mp3_to_wav | Convert MP3 to WAV Online - MP3 to WAV Converter |
convert.flac_to_wav | Convert FLAC to WAV Online - FLAC to WAV Converter |
convert.wav_to_flac | Convert WAV to FLAC Online - WAV to FLAC Converter |
convert.website_to_pdf | Convert HTML to PDF Online - HTML to PDF Converter |
convert.word_to_pdf | Convert Word to PDF Online - Word to PDF Converter |
convert.powerpoint_to_pdf | Convert PowerPoint to PDF Online - PowerPoint to PDF Converter |
convert.oxps_to_pdf | Convert OXPS to PDF Online - OXPS to PDF Converter |
convert.word_to_text | Convert Word to Text Online - Word to TXT Converter |
convert.powerpoint_to_text | Convert PowerPoint to Text Online - PowerPoint to TXT Converter |
convert.jpg_to_pdf | Convert JPG to PDF Online - JPG to PDF Converter |
convert.png_to_pdf | Convert PNG to PDF Online - PNG to PDF Converter |
convert.markdown_to_pdf | Convert Markdown to PDF Online - Markdown to PDF Converter |
convert.markdown_to_html | Convert Markdown to HTML Online - Markdown to HTML Converter |
convert.markdown_to_epub | Convert Markdown to ePUB Online - Markdown to ePUB Converter |
convert.website_to_jpg | Convert Website to JPG. Create Website Thumbnail. Save Website as Image. HTML to JPG Converter |
convert.html_to_jpg | Convert HTML to JPG. Save Website as JPG Image. HTML to JPG Converter |
convert.website_to_png | Convert Website to PNG. Save Website as PNG Image. HTML to PNG Converter |
convert.html_to_png | Convert HTML to PNG. Save Website as PNG Image. HTML to PNG Converter |
convert.html_table_to_csv | Convert HTML Table to CSV Online - HTML to CSV Converter |
convert.excel_to_pdf | Convert Excel to PDF Online - Excel to PDF Converter |
convert.excel_to_html | Convert Excel to HTML Online - Excel to HTML Converter |
convert.excel_to_csv | Convert Excel to CSV Online - Excel to CSV Converter |
convert.excel_to_ods | Convert Excel to ODS Online - Excel to OpenOffice Calc ODS Converter |
convert.ods_to_csv | Convert OpenOffice Calc ODS to CSV Online - ODS to CSV Converter |
convert.ods_to_pdf | Convert OpenOffice Calc ODS to PDF Online - ODS to PDF Converter |
convert.ods_to_excel | Convert OpenOffice Calc ODS to Excel Online - ODS to Excel Converter |
convert.csv_to_excel | Convert CSV to Excel Online - CSV to Excel Converter |
convert.csv_to_xml | Convert CSV to XML Online - CSV to XML Converter |
convert.excel_to_xml | Convert Excel to XML Online - Excel to XML Converter |
convert.xml_to_json | Convert XML to JSON Online - XML to JSON Converter |
convert.xml_to_csv | Convert XML to CSV Online - XML to CSV Converter |
convert.xml_to_excel | Convert XML to Excel Online - XML to Excel Converter |
convert.excel_xml_to_excel_xlsx | Convert Excel XML to Excel XLSX Online - Excel XML to XLSX Converter |
convert.pdf_to_csv | Convert PDF to CSV Online - PDF to CSV Converter |
convert.pdf_to_excel | Convert PDF to Excel Online - PDF to Excel Converter |
convert.pdf_to_jpg | Convert PDF to JPG Online - PDF to JPG Converter |
convert.pdf_to_png | Convert PDF to PNG Online - PDF to PNG Converter |
convert.pdf_to_tiff | Convert PDF to TIFF Online - PDF to TIFF Converter |
convert.pdf_to_svg | Convert PDF to SVG Online - PDF to SVG Converter |
convert.pdf_to_html | Convert PDF to HTML Online - PDF to HTML Converter |
convert.pdf_to_text | Convert PDF to Text Online - PDF to Text Converter |
convert.png_to_jpg | Convert PNG to JPG Online - PNG to JPG Converter |
convert.jpg_to_png | Convert JPG to PNG Online - JPG to PNG Converter |
convert.heic_to_png | Convert HEIC to PNG Online - HEIC to PNG Converter |
convert.heic_to_jpg | Convert HEIC to JPG Online - HEIC to JPG Converter |
convert.png_to_webp | Convert PNG to WebP Online - PNG to WebP Converter |
convert.jpg_to_webp | Convert JPG to WebP Online - JPG to WebP Converter |
convert.tiff_to_webp | Convert TIFF to WebP Online - TIFF to WebP Converter |
convert.gif_to_webp | Convert GIF to WebP Online - GIF to WebP Converter |
convert.webp_to_png | Convert WebP to PNG Online - WebP to PNG Converter |
convert.webp_to_tiff | Convert WebP to TIFF Online - WebP to TIFF Converter |
convert.webp_to_bmp | Convert WebP to BMP Online - WebP to BMP Converter |
convert.webp_to_yuv | Convert WebP to YUV Online - WebP to YUV Converter |
convert.webp_to_pam | Convert WebP to PAM Online - WebP to PAM Converter |
convert.webp_to_pgm | Convert WebP to PGM Online - WebP to PGM Converter |
convert.webp_to_ppm | Convert WebP to PPM Online - WebP to PPM Converter |
convert.epub_to_mobi | Convert ePUB to MOBI Online - ePUB to MOBI Converter |
convert.epub_to_azw | Convert ePUB to AZW Online - ePUB to AZW Converter |
convert.mobi_to_epub | Convert MOBI to ePUB Online - MOBI to ePUB Converter |
convert.mobi_to_azw | Convert MOBI to AZW Online - MOBI to AZW Converter |
convert.azw_to_epub | Convert AZW to ePUB Online - AZW to ePUB Converter |
convert.azw_to_mobi | Convert AZW to MOBI Online - AZW to MOBI Converter |
convert.epub_to_pdf | Convert ePUB to PDF Online - eBook to PDF Converter |
convert.mobi_to_pdf | Convert MOBI to PDF Online - eBook to PDF Converter |
convert.azw_to_pdf | Convert AZW to PDF Online - eBook to PDF Converter |
convert.azw3_to_pdf | Convert AZW3 to PDF Online - eBook to PDF Converter |
convert.fb2_to_pdf | Convert FB2 to PDF Online - eBook to PDF Converter |
convert.fbz_to_pdf | Convert FBZ to PDF Online - eBook to PDF Converter |
convert.pdf_to_epub | Convert PDF to ePUB Online - PDF to eBook Converter |
convert.pdf_to_mobi | Convert PDF to MOBI Online - PDF to eBook Converter |
convert.pdf_to_azw | Convert PDF to AZW Online - PDF to eBook Converter |
convert.pdf_to_azw3 | Convert PDF to AZW3 Online - PDF to eBook Converter |
convert.pdf_to_fb2 | Convert PDF to FB2 Online - PDF to eBook Converter |
convert.pdf_to_fbz | Convert PDF to FBZ Online - PDF to eBook Converter |
convert.remove_exif | Remove EXIF Data from Photos Online |
convert.format_json | JSON Formatter Online - Format JSON file |
convert.validate_json | JSON Validator Online - Validate JSON file |
convert.json_to_xml | Convert JSON to XML Online - JSON to XML Converter |
convert.json_to_csv | Convert JSON to CSV Online - JSON to CSV Converter |
convert.json_to_excel | Convert JSON to Excel Online - JSON to Excel Converter |
convert.json_to_yaml | Convert JSON to YAML Online - JSON to YAML Converter |
convert.json_objects_to_csv | Convert JSON objects (one per line) to CSV Online - JSON to CSV Converter |
convert.json_objects_to_excel | Convert JSON objects (one per line) to Excel Online - JSON to Excel Converter |
convert.yaml_to_json | Convert YAML to JSON Online - YAML to JSON Converter |
convert.srt_to_csv | Convert SRT to CSV Online - SRT to CSV Converter |
convert.srt_to_excel | Convert SRT to Excel Online - SRT to Excel Converter |
Need help?
If you have any questions regarding the use of the Conversion Tools REST API - feel free to contact us.