OnlineConverter.com API (v1)

Get Started

Theonlineconverter.com is an online tool designed for converting a wide array of file types, including audio, video, images, and documents. The service allows for drag-and-drop functionality for file uploads, followed by conversion and download. No software installation or account registration is required for basic use.

Most of our file conversions offer advanced options to customize the output. For instance:

  • Audio Conversions: Trim audio, select codecs, adjust bit rate, and choose channels.
  • Video Conversions: Cut videos, select video and audio codecs, modify the bit rate, and adjust aspect ratio and resolution.
  • Image Conversions: Set image dimensions and compression levels.
  • Document Conversions: Define orientation, margins, and compression levels.

This guide will walk you through a typical implementation of the TheOnlineConverter API, covering conversions, and how to handle the results. For more detailed information on specific endpoints, please refer to the menu on the left. You can also find more use cases in our API code examples.

Authentication

Our API utilizes API keys to authenticate requests. You can generate, view, and manage your API keys from your User Dashboard.

Your API keys grant access to your account and credits, so it is crucial to keep them secure. Do not expose your secret API keys in publicly accessible areas such as GitHub repositories, client-side code, or other insecure locations.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without proper authentication will also fail.

Request Headers:

Header Description Required Valid Value
Content-Type Set the content type of the request. YES application/json
x-api-key Your API key for authentication YES qwerty

API Responses / Errors

The TheOnlineConverter.com API V1 uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the information provided by the client (e.g., a malformed parameter, invalid API key), and codes in the 5xx range indicate an error with our servers.

All responses, both successful and unsuccessful, will return a body in JSON format.

Responses:

Code Message
200 OK -- Your request has been succeeded.
400 Bad Request -- Your request parameter is invalid.
401 Unauthorized -- Your API key is invalid.
402 Payment Required -- Insufficient Credits.
403 Forbidden -- Your access is denied.
404 Not Found -- The specified content could not be found.
405 Method Not Allowed -- You tried to access with an invalid method.
406 Not Acceptable -- You requested a format that isn't supported.
409 Already exists -- You're requesting to do something that already exists.
422 Validation errors -- You're request is not valid.
429 Too Many Requests -- You're sending too many requests.
500 Internal Server Error -- We had a problem with our server. Try again later.

Supported Formats

The TheOnlineConverter.com API supports a wide variety of file formats across different categories. Below is a comprehensive list of all supported conversions. You can use these tables to quickly determine if your desired input-to-output conversion path is available.

Image Supported Formats:

From To
PNG JPG , BMP , EPS , GIF , PS , PSD , TIFF , TGA , SVG , AI , PPM , WEBP , DDS , ICO , CDR , JSON , CUR , RAW , TXT , PDF , WORD , EXCEL
JPG PNG , BMP , EPS , GIF , PSD , TIFF , TGA , SVG , AI , PPM , WEBP , DDS , DWG , ICO , RAW , TXT , PDF , WORD , EXCEL , PPTX , JPEG
AVIF PNG , JPG
ARW JPG
JP2 AI , BMP , EPS , GIF , JPG , PNG , PSD , SVG , TGA , TIFF
SVG EPS , JPG , PDF , PNG , PSD , AI , BMP , TIFF , TGA
ICO PNG
BMP EPS , JPG , PDF , PNG , SVG , TIFF , PS , WEBP , GIF , TGA
GIF JPG , PDF , MP4 , SVG , PNG , WEBP
PSD AI , JPG , PDF , PNG , SVG , TIFF , EPS , DDS , TGA , GIF
AI EPS , JPG , PDF , PNG , PSD , SVG , TIFF , CDR , BMP
TIFF EPS , JPG , PDF , PNG , SVG , BMP , GIF , PSD , AI , TGA
WEBP GIF , JPG , PDF , PNG , SVG , AI , BMP , DDS , EPS , JP2 , PPM , PSD , TGA , TIFF
TGA JPG , PNG , BMP , GIF , EPS , PSD , SVG , TIFF , PDF
PPM EPS , JPG , PNG
JFIF JPG , PNG , PDF
HEIC JPG , PNG , PDF
EPS JPG , PNG , PDF , SVG , AI
DDS JPG , PNG , PSD
PS PDF
CDR JPG , PNG
JPEG JPG , PNG , BMP , EPS , GIF , PDF , PSD , SVG , TIFF
NEF JPG
DNG JPG

Document Supported Formats:

From To
PDF AI , CDR , BMP , EPS , JPG , PNG , PSD , SVG , TIFF , PS , WORD , PPT , PPM , ODT , HTML , EPUB , TXT , CSV , MOBI , AZW3 , ZIP , EXCEL , LATEX
TXT PDF , JSON , RTF , ODT , EPUB , WORD
WORD PDF , ODT , EPUB , JPG , MOBI , PPT , TXT
PPT PDF , JPG , PPTX , WORD , ODP , TXT
PPTX PDF , JPG , WORD , ODP , TXT
RTF PDF , WORD , HTML , EPUB , TXT
EXCEL PDF , CSV , HTML , JPG , JSON , TSV , ODS
ODT PDF , WORD , EPUB , HTML , RTF , TXT
HTML PDF , PNG , JPG
JSON PDF , EXCEL
MOBI PDF , EPUB
AZW3 PDF
CSV EXCEL , JSON , HTML , SQL
EPUB MOBI , PDF
IPYNB HTML , PDF
CBZ PDF
VCF CSV
OTF TTF
7Z ZIP
RAR ZIP
EML PDF
TEX PDF
YAML JSON
SQL CSV
SRT VTT
VTT SRT
MD PDF

Audio Supported Formats:

From To
MP3 WAV , M4R , AAC
M4A MP3 , WAV
OGG MP3 , WAV
FLAC MP3
MIDI MP3 , WAV
WMA MP3
AMR MP3
OPUS MP3
AAC MP3
AIFF MP3

Video Supported Formats:

From To
MP4 MP3 , AVI , GIF , MOV , WAV , WMV , 3GP , DIVX , WEBM , FLV
WMV MP4 , GIF
MOV MP4 , GIF
3GP MP4
AVI MP4 , GIF
FLV MP4
VOB MP4
MTS MP4
MKV MP4
WEBM MP4 , GIF

Image Converter API

The Image Converter API allows you to programmatically convert image files between various formats. The API is designed to be flexible, supporting both single-file and batch conversions. It also includes advanced features like Optical Character Recognition (OCR) when converting images to PDF.

Body (form-data):

Field Type Description Required
from string The original file format (e.g., png, jpg). YES
to string The target file format (e.g., pdf, pptx). YES
file file The file to be converted. YES

Conversion-Specific Parameters:

Depending on the target format, you can specify additional parameters to customize the output.

PNG/JPG to PDF

When converting PNG or JPG files to PDF, you can process multiple files at once, optionally apply OCR, and merge the results into a single document.

Field Type Description Required Valid Values
file[] file The files to be converted. Use file[] for batch processing. YES N\A
convert_type string Specifies whether OCR should be applied. YES ocr non_ocr
output_type string Determines if multiple files should be merged into a single PDF. YES merge non_merge
JPG to PPTx

When converting JPG files to PowerPoint, you can process multiple files at once, optionally merge the results into a single document.

Field Type Description Required Valid Values
file[] file The files to be converted. Use file[] for batch processing. YES N\A
output_type string Determines if multiple files should be merged into a single PPTx. YES merge non_merge

Image Compressor API

The Image Compressor API allows you to reduce the file size of your images programmatically. By adjusting the quality parameter, you can achieve the optimal balance between file size and visual fidelity for your needs.

Supported Formats:

Formats
PNG JPG BMP JPEG WEBP

Body (form-data):

Field Type Description Required
file file The file to be compress. YES
quality integer Set Image Quality (e.g, 20 , 40). YES

Image Upscaler API

The Image Upscaler API leverages advanced AI to increase the resolution of your images while enhancing details and quality. This tool is perfect for improving low-resolution photos, with specialized options for enhancing faces and backgrounds.

Supported Formats:

Formats
PNG JPG BMP JPEG TIFF AVIF WEBP HEIC

Body (form-data):

Field Type Description Required Valid Values
file file The file to be upscale. YES N\A
upscale_factor string Image Upscaling Factor. YES 2x 4x
face_upsample boolen Image Face Upsample. YES true false
background_enhance boolen Enchance Image Background. YES true false

Background Remover API

The Background Remover API uses AI to automatically detect the primary subject in an image and remove the background, resulting in a clean asset with a transparent background. This service is perfect for e-commerce product shots, portraits, and graphic design projects.

Supported Formats:

Formats
PNG JPG BMP JPEG TIFF AVIF WEBP HEIC

Body (form-data):

Field Type Description Required
file file The file to be background remove. YES

Object Remover API

The Object Remover API allows you to programmatically remove unwanted objects, people, or text from an image. By providing a "mask" image that highlights the specific area to be removed, our AI-powered tool intelligently erases the object and reconstructs the background for a seamless result.

Supported Formats:

Formats
PNG JPG BMP JPEG TIFF AVIF WEBP HEIC

Body (form-data):

Field Type Description Required
original_image file The file to be object remove. YES
mask_image file The file to be remove object mask. YES

Image To Text API

The Image To Text API provides powerful Optical Character Recognition (OCR) functionality, allowing you to extract text from images and PDF documents. This tool is ideal for digitizing documents, processing forms, and making image-based content searchable.

Supported Formats:

Formats
PNG JPG PDF JPEG TIFF HEIC

Body (form-data):

Field Type Description Required
file file The file to be convert. YES

Image TranslatorAPI

The Image Translator API enables you to automatically translate text within images into your desired language. Powered by advanced OCR and neural translation technologies, it detects and extracts text from images and returns the translated version with high accuracy.

This API is ideal for translating scanned documents, signs, product labels, and screenshots into multiple languages with minimal effort.

To use this API, make sure to refer to the language codes listed for each supported language when specifying your input and target languages in the request.

Supported Formats:

Formats
PNG JPG JPEG WEBP

Supported Languages:

Code Language
auto Auto Detect
ab Abkhaz
ace Acehnese
ach Acholi
aa Afar
af Afrikaans
sq Albanian
alz Alur
am Amharic
ar Arabic
hy Armenian
as Assamese
av Avar
awa Awadhi
ay Aymara
az Azerbaijani
ban Balinese
bal Baluchi
bm Bambara
bci Baoulé
ba Bashkir
eu Basque
btx Batak Karo
bts Batak Simalungun
bbc Batak Toba
be Belarusian
bem Bemba
bn Bengali
bew Betawi
bho Bhojpuri
bik Bikol
bs Bosnian
br Breton
bg Bulgarian
bua Buryat
yue Cantonese
ca Catalan
ceb Cebuano
ch Chamorro
ce Chechen
ny Chichewa
zh-CN Chinese (Simplified)
zh-TW Chinese (Traditional)
chk Chuukese
cv Chuvash
co Corsican
crh Crimean Tatar (Cyrillic)
crh-Latn Crimean Tatar (Latin)
hr Croatian
cs Czech
da Danish
fa-AF Dari
dv Dhivehi
din Dinka
doi Dogri
dov Dombe
nl Dutch
dyu Dyula
dz Dzongkha
en English
eo Esperanto
et Estonian
ee Ewe
fo Faroese
fj Fijian
tl Filipino
fi Finnish
fon Fon
fr French
fr-CA French (Canada)
fy Frisian
fur Friulian
ff Fulani
gaa Ga
gl Galician
ka Georgian
de German
el Greek
gn Guarani
gu Gujarati
ht Haitian Creole
cnh Hakha Chin
ha Hausa
haw Hawaiian
iw Hebrew
hil Hiligaynon
hi Hindi
hmn Hmong
hu Hungarian
hrx Hunsrik
iba Iban
is Icelandic
ig Igbo
ilo Ilocano
id Indonesian
iu-Latn Inuktut (Latin)
iu Inuktut (Syllabics)
ga Irish
it Italian
jam Jamaican Patois
ja Japanese
jw Javanese
kac Jingpo
kl Kalaallisut
kn Kannada
kr Kanuri
pam Kapampangan
kk Kazakh
kha Khasi
km Khmer
cgg Kiga
kg Kikongo
rw Kinyarwanda
ktu Kituba
trp Kokborok
kv Komi
gom Konkani
ko Korean
kri Krio
ku Kurdish (Kurmanji)
ckb Kurdish (Sorani)
ky Kyrgyz
lo Lao
ltg Latgalian
la Latin
lv Latvian
lij Ligurian
li Limburgish
ln Lingala
lt Lithuanian
lmo Lombard
lg Luganda
luo Luo
lb Luxembourgish
mk Macedonian
mad Madurese
mai Maithili
mak Makassar
mg Malagasy
ms Malay
ms-Arab Malay (Jawi)
ml Malayalam
mt Maltese
mam Mam
gv Manx
mi Maori
mr Marathi
mh Marshallese
mwr Marwadi
mfe Mauritian Creole
chm Meadow Mari
mni-Mtei Meiteilon (Manipuri)
min Minang
lus Mizo
mn Mongolian
my Myanmar (Burmese)
nhe Nahuatl (Eastern Huasteca)
ndc-ZW Ndau
nr Ndebele (South)
new Nepalbhasa (Newari)
ne Nepali
bm-Nkoo NKo
no Norwegian
nus Nuer
oc Occitan
or Odia (Oriya)
om Oromo
os Ossetian
pag Pangasinan
pap Papiamento
ps Pashto
fa Persian
pl Polish
pt Portuguese (Brazil)
pt-PT Portuguese (Portugal)
pa Punjabi (Gurmukhi)
pa-Arab Punjabi (Shahmukhi)
qu Quechua
kek Qʼeqchiʼ
rom Romani
ro Romanian
rn Rundi
ru Russian
se Sami (North)
sm Samoan
sg Sango
sa Sanskrit
sat-Latn Santali (Latin)
sat Santali (Ol Chiki)
gd Scots Gaelic
nso Sepedi
sr Serbian
st Sesotho
crs Seychellois Creole
shn Shan
sn Shona
scn Sicilian
szl Silesian
sd Sindhi
si Sinhala
sk Slovak
sl Slovenian
so Somali
es Spanish
su Sundanese
sus Susu
sw Swahili
ss Swati
sv Swedish
ty Tahitian
tg Tajik
ber-Latn Tamazight
ber Tamazight (Tifinagh)
ta Tamil
tt Tatar
te Telugu
tet Tetum
th Thai
bo Tibetan
ti Tigrinya
tiv Tiv
tpi Tok Pisin
to Tongan
lua Tshiluba
ts Tsonga
tn Tswana
tcy Tulu
tum Tumbuka
tr Turkish
tk Turkmen
tyv Tuvan
ak Twi
udm Udmurt
uk Ukrainian
ur Urdu
ug Uyghur
uz Uzbek
ve Venda
vec Venetian
vi Vietnamese
war Waray
cy Welsh
wo Wolof
xh Xhosa
sah Yakut
yi Yiddish
yo Yoruba
yua Yucatec Maya
zap Zapotec
zu Zulu

Body (form-data):

Field Type Description Required
file file The file to be convert. YES
base_lang string Enter language code of input file content. YES
target_lang string Enter language code for output. YES

Handwriting To Text API

The Handwriting To Text API utilizes an advanced Optical Character Recognition (OCR) engine specifically trained to recognize and transcribe handwritten text from images and scanned documents. This powerful tool can digitize handwritten notes, letters, and forms with high accuracy.

Supported Formats:

Formats
PNG JPG PDF JPEG

Body (form-data):

Field Type Description Required
file file The file to be convert. YES

Output Process API

Many API operations, such as complex conversions or enhancements, are processed asynchronously. When you initiate such a task, the API will immediately return a process_id. You can use the Output Process API endpoint to poll the status of this job and retrieve the final output file once the processing is complete.

Body (form-data):

Field Type Description Required
process_id string Process ID for get output file/status. YES

Document Converter API

The Document Converter API enables the conversion of various document types into different formats, such as Word, Excel, PDF, and PPTx. The API is built to handle both single and multiple files (batch processing) and includes powerful Optical Character Recognition (OCR) capabilities for converting scanned PDFs into editable documents.

The Document Converter API allows users to convert image files between various formats, including Word, Excel, PDF, and PPTx. The API supports batch processing and provides OCR (Optical Character Recognition) functionality for PDF conversions.

Body (form-data):

Field Type Description Required
from string The original file format (e.g., png, jpg). YES
to string The target file format (e.g., pdf, pptx). YES
file file The file to be converted. YES

Merge PDF API

The Merge PDF API provides a simple and efficient way to combine multiple PDF documents into a single, consolidated PDF file. You can upload two or more files in a single request, and the API will merge them in the order they are provided.

Body (form-data):

Field Type Description Required
file[] file The files to be merged. Use file[] for multiple files. YES

Split PDF API

The Split PDF API offers a flexible way to break a single PDF document into multiple, smaller files. You can define specific pages or page ranges to extract. The API also allows you to choose whether to create separate files for each specified range or to combine all extracted pages into a single new PDF document.

Body (form-data):

Field Type Description Required Values
file file The file to be split. YES N\A
ranges[] array Set ranges[] to be pdf split. YES Pages : 1 , 31 , 49 , 123 Ranges : 1-31 , 49-123 , 149-265
merge boolen Want to merge. YES ture false

PDF Compressor API

The PDF Compressor API allows you to reduce the file size of your PDF documents. By choosing from three distinct compression levels, you can find the perfect balance between file size and document quality for your specific use case.

Body (form-data):

Field Type Description Required Values
file file The file to be compressed. YES N\A
compress_level string How much compress the file. YES extreme medium less

Password Protect PDF API

The Password Protect PDF API allows you to secure your PDF documents by adding a password. Once protected, the PDF will require the specified password to be opened and viewed, ensuring that only authorized users can access its content.

Body (form-data):

Field Type Description Required
file file The file to be lock. YES
password string Set your password. YES

UnLock PDF API

The Unlock PDF API allows you to remove password protection from a PDF file. By providing the correct password, you can create a new, unlocked version of the document that can be opened by anyone without requiring a password.

Body (form-data):

Field Type Description Required
file file The file to be lock. YES
password string Set your password. YES

Audio Converter API

The Audio Converter API provides a comprehensive solution for converting audio files between various formats. Beyond simple conversion, the API offers a suite of advanced features, allowing you to trim the audio, change codecs, adjust channels, modify the sample rate, and control the output volume.

Body (form-data):

Field Type Description Required
from string The original file format (e.g., png, jpg). YES
to string The target file format (e.g., pdf, pptx). YES
file file The file to be converted. YES
cut_from string Start time for trimming (format: HH:MM:SS). NO
cut_to string End time for trimming (format: HH:MM:SS). NO
audio_codec string Audio codec for output file (e.g., aac, mp3, opus). YES
audio_channel string Audio channel layout (e.g., 1, 2, 5). NO
frequency string Sample rate (e.g., 44100, 48000) Hz. NO
volume string Adjust output volume (e.g., -10dB, -50dB, 30dB). NO

Additional Configuration:

cut_from HH:MM:SS
cut_to HH:MM:SS
audio_codec pcm_alaw pcm_mulaw pcm_s16le pcm_s24le pcm_s32le
audio_channel 1 2 3 4 5 6 7 8
frequency 1000 2000 4000 6000 7350 8000 11025 12000 16000 22050 24000 32000 44100 48000 64000 88200 96000
volume -100dB -90dB -80dB -70dB -60dB -50dB -40dB -30dB -20dB -10dB no_change 10dB 20dB 30dB 40dB 50dB 60dB 70dB 80dB 90dB 100dB

Video Converter API

The Video Converter API is a powerful and flexible tool for transcoding video files. It supports a wide range of formats and offers extensive customization options for both video and audio streams. You can trim clips, change codecs, adjust resolution and quality, modify audio channels, and much more, all through a single endpoint.

Body (form-data):

Field Type Description Required
from string The original file format (e.g., png, jpg). YES
to string The target file format (e.g., pdf, pptx). YES
file file The file to be converted. YES
cut_from string Start time for trimming (format: HH:MM:SS). NO
cut_to string End time for trimming (format: HH:MM:SS). NO
video_codec string Video encoding format (e.g. , libx264). YES
video_resolution string Output resolution (e.g., 1920x1080). NO
ratio string Aspect ratio (e.g., 16:9, 4:3). NO
quality integer Video quality (1–51, where 23 = normal). YES
speed string Encoding speed vs. quality tradeoff (e.g., medium). YES
fit string Escaling behavior (e.g., crop , scale). NO
audio_codec string Audio codec for output file (e.g., aac, mp3, opus). YES
audio_channel string Audio channel layout (e.g., 1, 2, 5). NO
frequency string Sample rate (e.g., 44100, 48000) Hz. NO
volume string Adjust output volume (e.g., -10dB, -50dB, 30dB). NO

Additional Configuration:

cut_from HH:MM:SS
cut_to HH:MM:SS
video_codec libx264 libx265 libxvid
video_resolution 320x240 640x480 854x480 960x720 1280x720 1440x1080 1920x1080 2560x1440 3840x2160
ratio 16:9 14:9 4:3
quality 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
speed ultrafast superfast veryfast faster fast medium slow slower veryslow
fit max crop scale pad
audio_codec pcm_alaw pcm_mulaw pcm_s16le pcm_s24le pcm_s32le
audio_channel 1 2 3 4 5 6 7 8
frequency 1000 2000 4000 6000 7350 8000 11025 12000 16000 22050 24000 32000 44100 48000 64000 88200 96000
volume -100dB -90dB -80dB -70dB -60dB -50dB -40dB -30dB -20dB -10dB no_change 10dB 20dB 30dB 40dB 50dB 60dB 70dB 80dB 90dB 100dB
CURL Request
Response JSON
JavaScript Fetch
Response JSON
Ruby Net::HTTP
Response JSON
Python Requests
Response JSON
PHP Guzzle
Response JSON
Java HttpURLConnection
Response JSON
Go net/http
Response JSON
C# HttpClient
Response JSON