API Documentation

Getting Started

The Conversion Tools REST API provides HTTP-based access to our file conversion services using token authentication. All requests and responses use JSON format.

Libraries

We maintain official REST API client libraries for the most popular languages:

npm install conversiontools

pip install conversiontools

composer require conversiontools/conversiontools-php

OpenAPI 3.0 Specification: Download openapi.yaml -- Use with code generators, API testing tools, or explore with Swagger Editor

Pricing

Our API offers flexible, pay-as-you-grow pricing with unlimited sandbox testing.

All plans include:

• Unlimited sandbox testing
• OpenAPI specification
• Node.js, Python, and PHP libraries
• Webhook callbacks
• 100 AI Conversion Credits/month (separate from regular API calls). Buy more anytime

View detailed pricing →

Authentication

When your account is created, we generate an API Token for accessing the Conversion Tools REST API. You can find it on your Profile page.

Pass the token in the Authorization header using the Bearer scheme:

Authorization: Bearer <API Token>

Sample request verifying API access:

curl -sSX GET https://api.conversiontools.io/v1/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API Token>"

API URL

The Conversion Tools REST API is available at:

API Requests

Each API request must contain the following components:

• The HTTP method: GET or POST
• Authorization header with your API Token
• Content-Type: application/json header
• A JSON request body (see API Reference below)

Example: creating a new conversion task:

curl -sSX POST https://api.conversiontools.io/v1/tasks \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API Token>" \
  -d '{
  "type": "convert.website_to_jpg",
  "options": {
    "url": "http://google.com",
    "images": "yes"
  }
}'

API Response

Every API response contains an error field plus optional data:

{
  "error": "<error text>",
  <data>
}

{
  "error": null,
  "task_id": "4147c475ffe94ec8a11aff9a6a8f437a"
}

{
  "error": "Bad request"
}

API Reference

The file conversion process consists of 4 steps:

1. Upload file to the server (optional when a URL is provided)
2. Run conversion task
3. Get conversion task status
4. Download the result file

1Upload file to the server

If you are providing the file by URL, skip to Step 2.

Upload a file using an HTTP POST request with Content-Type: multipart/form-data.

Headers:

Authorization: Bearer <API Token>
Content-Type: multipart/form-data

Parameters:

Response:

{
  "error": null,
  "file_id": "be87de1a680c4451a49a72df3fecd3fd"
}

Example:

curl -sSX POST https://api.conversiontools.io/v1/files \
  -H "Authorization: Bearer <API Token>" \
  -F "file=@/home/user/Desktop/test.xml"

2Run conversion task

Parameters:

Options parameters:

Response:

{
  "error": null,
  "task_id": "4147c475ffe94ec8a11aff9a6a8f437a"
}

3Get conversion task status

Poll this endpoint until the task finishes (check the status field).

Example:

curl -sSX GET https://api.conversiontools.io/v1/tasks/d9b5369bfc6541d88581d4ff80954917 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API Token>"

Status values:

{
  "error": null,
  "status": "SUCCESS",
  "file_id": "ce87de1a680c4451a49a72df3fecd3fe"
}

{
  "error": "Wrong file format",
  "status": "ERROR",
  "file_id": null
}

4Download result file

The response includes a Content-Disposition: attachment; header, which triggers the file download in browsers. When using the SDK, the response body contains the raw file bytes.

Available Conversion Types

Below are all conversion types that accept configurable options. Click a row to expand and see its parameters. For the full specification, refer to the OpenAPI specification.

See all converters available on the website.

Need Help?

If you have any questions about the Conversion Tools REST API, feel free to contact us.