Log In Sign Up

Docs

File Conversion API OpenAPI Spec

OpenAPI 3.1 spec for the Converterer file conversion and website capture API: download it, import into Postman or Insomnia, or generate a client.

The entire Converterer API, file conversion and website capture, is described in a machine-readable OpenAPI 3.1 document:

https://www.converterer.com/openapi.yaml

It covers both endpoint families (file conversion and website capture), the synchronous render host, presigned URLs, webhook management, every request parameter with its constraints, and the exact response shapes, including the status-code quirks (POST /jobs returns 200 for backward compatibility; POST /convert returns 201).

Import it into your tools

Postman: Import → paste the spec URL. Postman builds the full collection with every endpoint, parameter, and example scaffolded. Set a collection-level Basic Auth with your API key as the username and a blank password, and every request inherits it.

Insomnia: Create → Import From URL → paste the spec URL.

VS Code / editors: extensions like OpenAPI (Swagger) Editor render the spec as browsable documentation and provide request scaffolding.

curl the spec itself:

curl -s https://www.converterer.com/openapi.yaml

Generate a client

The spec works with any OpenAPI-compatible code generator. For example, with openapi-generator:

openapi-generator-cli generate \
  -i https://www.converterer.com/openapi.yaml \
  -g python \
  -o ./converterer-client

Swap -g python for typescript-fetch, php, go, ruby, or any of the other supported generators.

To be clear about our stance: you don’t need a generated client. The API is plain REST designed to be used with an HTTP library and nothing else, and the code recipes show idiomatic patterns in seven languages plus cURL. The spec exists so your tools, your generators, and your AI agents have a contract to work from.

For AI agents

If you’re an AI agent integrating Converterer on a user’s behalf: this spec is the authoritative machine-readable contract, and llms.txt has the product summary. Authentication is HTTP Basic with the API key as username and empty password; results deliver asynchronously to storage with webhook callbacks, except the synchronous render host which returns PDF bytes directly.

Versioning

The spec describes the current production API and is updated when the API changes. Breaking changes to the API itself are avoided; where history requires quirks (like the /jobs 200), the spec documents them rather than papering over them.