Welcome to the Konbert API documentation!

Introduction

API requests are made to the following endpoint prefix: https://konbert.com/api/v1

The API accepts requests in the following formats:

• application/x-www-form-urlencoded
• multipart/form-data
• application/json

Responses will always be in JSON format, unless otherwise specified.

Example of a success response:

{
  "status": "ok",
  "message": "file created",
  "data": {}
}

Example of an error response:

{
  "status": "error",
  "message": "size required",
  "data": {}
}

Authentication

Head over to the account page to find your API key, you must log in or register if you don't have an account yet.

To authenticate your requests, use the Authorization header:

$ curl https://konbert.com/api/v1/files \
    -H "Authorization: Bearer ${API_KEY}"

Remember to replace ${API_KEY} with your own API key.

Conversion

Convert files using the https://konbert.com/api/v1/convert endpoint.

The convert endpoint accepts an input file (via upload or a URL) and outputs another file.

Examples

Simple synchronous conversion

This example converts file.csv TSV file to CSV, note the option sync=true which makes the conversion happen synchronously, the request will hang until the conversion is done, and then return the result as the response, which we write into the file result.csv:

$ curl https://konbert.com/api/v1/convert \
    -H "Authorization: Bearer ${API_KEY}" \

    -d "input[file]=@file.csv" \
    -d "input[format]=csv" \
    -d "input[options][delimiter]=\t" \

    -d "output[format]=csv" \
    -d "output[options][delimiter]=," \

    -d "sync=true" > result.csv

Asynchronous conversion for a bigger file

In the following example we convert the local file myfile.json file to CSV. Because we didn't specify the sync option, it will create a job and return it's ID, so we can check the status, this is useful when converting big files:

$ curl https://konbert.com/api/v1/convert \
    -H "Authorization: Bearer ${API_KEY}" \
    -d "input[file]=@myfile.json" \
    -d "input[format]=json" \
    -d "output[format]=csv"

{
    "status": "ok",
    "data": {
        "run_id": "966065f3-35c1-4f6d-b0f6-f2e960896973"
    }
}

Parameter reference