Summary

Introduction

Welcome to the online-convert API.

We have developed a public REST API to allow developers easy and direct access to all our conversion functionalities available at api2convert.com.

Please feel free to contact us with any kind of comments you may have, feature requests, questions or when help is needed. We are constantly improving our services.

The API can be accessed using SSL by the following endpoint:

  • https://api.api2convert.com

This is the API schema URL: https://api.api2convert.com/v2/schema

The schema follows the Swagger 2.0 specification and defines the API.

The whole documentation will follow the definitions given in this schema.

The API uses a REST architecture for interaction. That means that every single URI represents a different object in the API and the actions requested through the HTTP methods.

The current methods allowed to interact with the API are:

  • GET: Gathers information of the object. It will not, by any means, modify data on the server.
  • POST: Creates new elements in the API. Used to create the different objects in the API.
  • PATCH: Modifies an existing element in the API.
  • DELETE: Removes existing elements via API

Quickstart

In order to create a simple conversion of a file located at an external URL, the following request is made.

Example Conversion

POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Oc-Api-Key: <your API key here>
Content-Type: application/json
{
    "input": [{
        "type": "remote",
        "source": "https://example-files.online-convert.com/raster%20image/jpg/example_small.jpg"
    }],
    "conversion": [{
        "category": "category",
        "target": "png",
        "options": {
            <conversion options here>
        }
    }]
}

Intended audience

Using the API may be interesting for you if you want to:

  • Integrate a file conversion service on your website, app or extension
  • Convert files regularly
  • Outsource the file conversion process to our fast server farm to speed up conversion time

Requirements

Our API is available in two flavours:

  • Free
  • Paid for professional use (login to see pricing)

For both types you will need a personal API key. Instructions on how to get it can be found here.

Tutorials

Examples

You can find examples for conversions all throughout the documentation.

Tutorials at our blog

You can find API related tutorials on our BLOG

Video tutorials

We have created a set of video tutorials to help you quick start creating your own application.

The first tutorial is an introduction to our API including first API calls.

The second tutorial covers uploading, conversion options and batch conversion.

We are fully GDPR compliant

Data processing agreement

If you need a data processing agreement to be GDPR compliant you can then download the contract here.

Need help?

Get in contact with us

We love that so many developers have integrated our API and we don't want you to feel alone!

If you have any questions, do not hesitate to contact us via e-mail

In which situations can we help best?

Of course we can help you with all questions about how our API is working.

If you have language specific questions, we are very experienced with PHP but we maybe can help you also with other languages.

Please always include your JSON call, source code, error message and everything that could help us to reproduce your issue.

You have spotted a bug? No way!!!

Ok, we are not 100% perfect ;-) If you find bugs, we would be very happy if you include the steps to reproduce the issue.

We will fix them as soon as possible.

In case you have a feature request

If you miss a feature, please let us know and we will evaluate your feature request as soon as possible.