Docs

switchfile API

Convert files from your own code. Start with one request to the simple API, or keep your CloudConvert code and change the URL.

QuickstartConvert your first file with one request.Simple API (v1)One request per file: send a file or a URL, get the result back.Jobs and tasks (v2)The request format of the CloudConvert API v2 with named tasks.API referenceEvery endpoint with its parameters and responses.Formats and optionsEach target format with its inputs and options.WebhooksSigned calls to your server when a conversion is done.

Two ways to use the API#

The simple API (v1) converts a file with one request. Send the file or a URL, name the target format, and get the result back in the same response or later. Start with the Quickstart and the Simple API guide.

Jobs and tasks (v2) take the same request bodies as the CloudConvert API v2: a job with named tasks, for example one that imports a file and one that converts it. If you already use CloudConvert, change the base URL and the API key and keep the rest of your code. See Jobs and tasks.

Both use the same API keys, credits, formats and options.

Base URL#

Text

https://api.switchfile.io

Every request goes over HTTPS. Requests and responses use JSON, except for file uploads and downloads.

What you need#

An API key from the dashboard. Free accounts can create keys too. See Authentication.
For tests that do not use credits, a sandbox key. See Sandbox.

Machine-readable description#

The whole API is described in openapi.json (OpenAPI 3.0). You can load it into tools such as Postman or generate a client from it. Every endpoint is also on its own page in the API reference.