Reference

API reference

Every endpoint with its parameters and responses, errors included. Base URL https://api.switchfile.io. The same description as a file: openapi.json (OpenAPI 3.0).

Simple API (v1)

One request per conversion: send a file, get the converted file back.

POSTConvert a file/v1/convertGETShow a conversion/v1/conversions/{id}GETList conversions/v1/conversionsDELETEDelete a conversion/v1/conversions/{id}POSTCreate an upload/v1/uploadsPUTSend the file of an upload/v1/uploads/{id}/contentDELETEDelete an upload/v1/uploads/{id}POSTCreate a batch/v1/batchesGETShow a batch/v1/batches/{id}DELETEDelete a batch/v1/batches/{id}POSTCreate a ZIP archive/v1/archivesGETDownload a ZIP archive/v1/archives/{id}GETList formats/v1/formatsGETShow the account/v1/accountPATCHUpdate the account/v1/account

Jobs (v2)

Jobs group tasks in the format of the CloudConvert API v2.

POSTCreate a job/v2/jobsGETList jobs/v2/jobsGETShow a job/v2/jobs/{id}GETWait for a job/v2/jobs/{id}/waitDELETEDelete a job/v2/jobs/{id}

Tasks (v2)

Single steps of a job, such as an import or a conversion.

GETList tasks/v2/tasksGETShow a task/v2/tasks/{id}GETWait for a task/v2/tasks/{id}/waitPOSTCancel a task/v2/tasks/{id}/cancelPOSTRetry a task/v2/tasks/{id}/retryPOSTFinish a direct upload/v2/tasks/{id}/upload-complete

Uploads and downloads (v2)

Signed upload and download URLs. They work without an API key.

POSTUpload a file for an import/upload task/upload/{taskId}GETDownload a file/files/{fileId}/{filename}

Formats (v2)

Supported pairs of input and output formats.

GETList supported conversions/v2/convert/formats

Account (v2)

The account of the API key.

GETShow the current user/v2/users/me

Health

Status of the API.

GETHealth check/health