Sign up
Documentation menu

OpenAPI schema

ConvertAPI provides a comprehensive OpenAPI schema (formerly known as Swagger) that defines the entire API surface - a machine-readable description of how the ConvertAPI service operates.

You can find the latest ConvertAPI OpenAPI schema here: https://v2.convertapi.com/info/openapi

If you'd like the OpenAPI schema of a specific endpoint - for example, converting DOCX to PDF - you can use: https://v2.convertapi.com/info/openapi/docx/to/pdf

To list all endpoints that convert to PDF: https://v2.convertapi.com/info/openapi/*/to/pdf

To see all conversion possibilities for a PDF file: https://v2.convertapi.com/info/openapi/pdf/to/*

This pattern applies to all file formats and all supported conversions.

What the schema contains

  • Endpoints: all available API endpoints (e.g. /convert/docx/to/pdf) and their HTTP methods.
  • Parameters: path, query, header, and request body parameters for each endpoint, with data types, formats, and required/optional status.
  • Responses: expected response structures for each status code, including data models and examples.
  • Data models: definitions of the objects used in requests and responses.

What you can do with it

  • Generate client SDKs in your preferred language using standard OpenAPI tooling.
  • Explore the API - the schema doubles as interactive documentation of endpoints, parameters, and responses.
  • Automate testing against the API specification, so your integration stays compatible as the API evolves.
  • Run mock servers that simulate ConvertAPI for development and testing without real API calls.