Convert.Online API
Convert files between more than 500 formats — images, video, audio, documents, ebooks, archives and fonts. A job is one conversion request. Inside it are…
Developer tools#documents--productivity
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Convert files between more than 500 formats — images, video, audio, documents, ebooks, archives and fonts.
A job is one conversion request. Inside it are tasks, named by you and wired together with input: something imports the source, convert changes the format, something exports the result. That structure is what lets one request pull a file from S3, convert it and drop it on SFTP.
The short version of the flow:
POST /v1/process/jobs— create the job. For an uploaded source you get an upload target back.- Send the bytes, if the source is a local file.
POST /v1/process/jobs/{id}/complete-upload— start the conversion.GET /v1/process/jobs/{id}untilstatusisfinished, or subscribe to/events.- Download from the export task's
result.url.
Set "sandbox": true on a job to validate it and get a simulated finished response — nothing converts, no quota is used, and no key is needed.
Limits follow the account that owns the key, whether or not it is signed in on the website: the monthly quota (plus any top-up), up to 20 GB per file, and a time limit for each conversion of 15 minutes on the free plan and 3 hours on paid plans and top-ups. A conversion that runs past it fails with Conversion took longer than your plan allows and its quota is given back. See https://convert.online/plans.
Endpoints 18
Catalogue
- GETList formats
/v1/formatsWith no argument, every format we can read. With input_format, every format that input can be converted to. The answer comes from the same catalogue the… - GETList the settings one conversion accepts
/v1/options?input_format=mp4&output_format=webmResize, quality, codecs, bitrate, trim, crop and the rest — with the exact names, types and allowed values for this pair. Option names differ per conversion,…
Jobs
- POSTCreate a conversion job
/v1/process/jobsCreates a job from a map of named tasks. A task's input names the task it takes its source from, which is how several steps chain into one job. When the… - GETGet a job
/v1/process/jobs/:jobIdPoll until status is finished or failed. The finished job's export task carries the download URL. - POSTStart the conversion once the bytes have arrived
/v1/process/jobs/:jobId/complete-uploadCall this after sending the file. Until it is called the job stays at waiting_upload and nothing is converted. - GETFollow a job as it runs (Server-Sent Events)
/v1/process/jobs/:jobId/eventsAn text/event-stream of the job's progress, so a client can react the moment the conversion ends instead of polling.
Imports
- POSTCreate an import to receive a local file
/v1/importsReturns somewhere to put the bytes. Use it for any file that is not already reachable at a URL. - PUTSend the file's bytes
/v1/imports/:importId/contentThe body is the raw file, streamed — not a form upload. POST is accepted as well as PUT.
Downloads
- GETDownload a converted file
/v1/download/:tokenThe URL a finished export/url task hands back. The token is the whole credential, so the link works on its own. Downloads use no quota; each converted file…
Android app
- POSTGet a challenge
/v1/auth/challengeA single-use value for one Play Integrity request. Valid 5 minutes, only for the action it was issued for. 30 per minute per IP. - POSTSign in with e-mail and password
/v1/auth/loginSame limits as the website: after repeated failures the address (and the IP) is refused for 15 minutes. An unknown address and a wrong password get the same… - POSTStart a sign-up
/v1/auth/registerChecks the address and password and e-mails a 6-digit code valid 15 minutes. No account exists until the code is confirmed. Password: at least 8 characters… - POSTConfirm the sign-up code
/v1/auth/register/verifyCreates the account (Free plan) and signs in. Five wrong codes in 15 minutes and the address is refused until the window passes; request a new code with… - POSTSend a new sign-up code
/v1/auth/register/resend - POSTE-mail a password-reset link
/v1/auth/password/forgotAlways answers 200, whether or not the address has an account. The link opens the website's reset page. - POSTSign in with Google
/v1/auth/googleid_token from Android Credential Manager, requested with the website's web client ID as serverClientId. Signs in to the account with that Google ID, else to… - GETAccount, plan and quota
/v1/meEverything the app's Account screen shows. Works with the app's OAuth token or an API key. - GETStored profile picture
/v1/me/avatarOnly for accounts whose picture is stored inline (avatar_url points here).
API details
- Base URL
https://api.convert.online- Authentication
- A bearer token in the Authorization header
An API key in the X-API-Key header - Operations
- 18 operations on 18 pathsPOST 10GET 7PUT 1
- Main resources
- Android app 9Jobs 4Catalogue 2Imports 2Downloads 1
- Response formats
application/jsonapplication/octet-streamimage/gifimage/jpeg- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- Convert's published OpenAPI description
How to test the Convert.Online API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Convert.Online API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List formats” (GET /v1/formats), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Convert.Online API?
Convert files between more than 500 formats — images, video, audio, documents, ebooks, archives and fonts. A job is one conversion request. Inside it are… It is listed under Developer tools and has 18 endpoints.
Who publishes the Convert.Online API?
It is listed from Convert's public API description (an OpenAPI document), not published by Convert on Swastik Codes. Anyone who controls convert.online can claim the profile by adding a DNS TXT record.
What is the base URL of the Convert.Online API?
Requests go to https://api.convert.online. Endpoint paths are added to this base URL.
How do I authenticate with the Convert.Online API?
It accepts 2 methods: A bearer token in the Authorization header; an API key in the X-API-Key header.
How many endpoints does the Convert.Online API have?
18 operations on 18 paths (10 POST, 7 GET, 1 PUT). The largest groups are Android app, Jobs, Catalogue, Imports.
Is forking the Convert.Online API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.