Public API

Public API v1

Build file conversion into your application with the Convertere Public API.

The Convertere Public API creates conversion jobs, accepts file uploads or HTTPS URL imports, and returns downloadable results. Use a live key for real conversions or a test key to exercise the same endpoints with simulated results.

Base URL

https://api.convertere.io/v1

All routes in these guides are relative to this base URL. The same API is also served at https://convertere.io/api/v1. GET /operations and GET /openapi.json are public; every other endpoint needs an API key.

The machine-readable description is the OpenAPI 3.1 document at /v1/openapi.json. It is generated from the code that serves the API, so it always matches the behaviour documented here.

How it works

  1. Create a job that describes an import, a conversion and an export.
  2. Give the job its file: PUT the bytes to the upload URL it returns, upload in parts for files over 100 MB, or let the platform fetch an HTTPS URL.
  3. Wait for the job: poll it, long-poll with ?wait=, or receive a signed webhook.
  4. Download the result from the export task. Results are kept for 24 hours.

Versioning

/v1 is additive only: new compatible fields and behaviour may be added while existing ones keep working. Breaking changes will use a new version path. Responses may include a Deprecation header when something is being retired.

Guides

Interactive API reference

On this page