API (Application Programming Interface)

The EditingTools.io API can be used to generate, convert and process data. This API provides access to a variety of different resources. The API is accessible through a REST interface. Unless noted otherwise, POST requests are recommended. Request parameters are used to pass information to the API, results are returned in JSON. Request parameters must be UTF-8 encoded; results are also encoded in UTF-8. HTTP errors codes are used to signal errors. Authentication is based on fixed keys, and data transport is secured by SSL.

Start Watermark Music Cue Sheet Other Tools

How to get access to the API?

To make any request to the API, you will need an EditingTools.io account and you need to apply for an APIKEY.

Make your first request

Once you have an APIKEY you’re ready to get started using our API.

curl -u "apikey:{YOUR_API_KEY}" -X {request_method} "{url}/{method}"

To validate your APIKEY and to recieve a list of available tools you can send a request to https://api.editingtools.io.

curl -u "apikey:{YOUR_API_KEY}" "https://api.editingtools.io"

Response (Example):

{
    "code": "200",
    "status": "OK",
    "data": {
        "api_list": [
            "watermark",
            "thumbnail",
            "..."
        ]
    }
}

Data handling

Results are returned as JSON encoded in UTF-8. Datasets will be inside data tag on default. Request parameters must be UTF-8 encoded.

Error handling

This api service uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2XX range indicate success. A response in the 4XX range is some sort of failure, and a response in the 5XX range indicates an internal system error that cannot be resolved by the user. The following error codes are used by the API:

200: OK. The request was successful.
400: Bad request. Please check error message.
401: Unauthorized: Username or Api Key is not valid.
403: Forbidden: The request is understood, but it has been refused or access is not allowed.
404: Not found: The URI requested is invalid or the resource does not exist.
429: Too Many Requests. Returned when a request cannot be served due to the App's rate limit having been exhausted for the resource.
500: Internal Server Error. Something is broken.
502: Bad Gateway. API is down.
503: Service Unavailable. API is up but overloaded with requests.
504: Gateway Timeout: API is up but requests reached timout.

Rate Limits

To prevent abuse and spam we have limits on different levels. There is a rate request limit per seconds, per day and per month. We can adjust limits according to your needs.

File Limits

File uploads are limited to 100MB.

Language

The API is only available in english language.

Other Tools

We can easily set up an API to all of our tools on demand.

Watermark

Use the Watermark API to generate a watermark graphic.

If you want to generate a watermark of 1920 x 1080 pixel and the text "INTERNAL USE ONLY" use the following command. Set HEADER to Content-Type: application/json and send your data in JSON format e.g. --data-raw '{"resolution":"1920x1080","text":"INTERNAL USE ONLY"}'. Default values will be used for all unset attributes.

curl -u "apikey:{YOUR_API_KEY}" -X POST "https://api.editingtools.io/watermark" --header 'Content-Type: application/json' --data-raw '{"resolution":"1920x1080","text":"INTERNAL USE ONLY"}'

Response (Example):

{
    "code": "200",
    "status": "OK",
    "data": {
        "created": "2022-08-14 21:21:43",
        "message": "Success",
        "file_url": "https://editingtools.io/path/to/file/watermark_123.png",
        "file_size": 15120,
        "file_hash": "13ba0a9e943f32ac4782d98fba36249b"
    }
}

You can download the generated file with wget or curl or embed it directly into your app from file_url. The generated file will be online for 20 minutes maximum . After download you can validate the file with MD5 HASH file_hash.

curl "https://editingtools.io/path/to/file/watermark_123.png" --output watermark.png

In case you want to save the output in the first request, you can add stream_output attribute with value true. Also define the output path e.g. --output watermark.png. In case the process fails, output will be send as JSON. So make sure to handle status codes correctly.

curl -u "apikey:{YOUR_API_KEY}" -X POST "https://api.editingtools.io/watermark" --header 'Content-Type: application/json' --data-raw '{"stream_output":true,resolution":"1920x1080","text":"INTERNAL USE ONLY"}' --output watermark.png

Music Cue Sheet

This is the official API to our Music Cue Sheet. All details about the Cue Sheet Generator can be found here: Music Cue Sheet.

To generate a cue sheet from a sequence the following command can be used:

curl -u "apikey:{YOUR_API_KEY}" -X POST -F format=csv -F [email protected]/path/to/myfile.edl "https://api.editingtools.io/cuesheet"

Response (Example):

{
    "code": "200",
    "status": "OK",
    "data": {
        "created": "2022-08-14 21:21:43",
        "message": "Success",
        "file_name": "MusicCueSheet.csv",
        "file_url": "https://editingtools.io/path/to/file/MusicCueSheet.csv",
        "file_size": 631,
        "file_hash": "149350685432f7d03ab148cef3dfe926"
    }
}

curl "https://editingtools.io/path/to/file/MusicCueSheet.csv" --output MusicCueSheet.csv

Instead of downloading the file you can recieve the file as base64 string. Add -F base64=1 to the request.

curl -u "apikey:{YOUR_API_KEY}" -X POST -F format=csv -F base64=1 -F [email protected]/path/to/myfile.edl "https://api.editingtools.io/cuesheet"

Response (Example):

{
    "code": "200",
    "status": "OK",
    "data": {
        "created": "2022-08-14 21:21:43",
        "message": "Success",
        "file_name": "MusicCueSheet.csv",
        "file_base64": "Tm8sVGltZWNvZGUgSW4sVGltZWNvZGUgT3V0LFRpdGxlLER1cmF0aW9uLFRyYWNrLE5vdGUKMiwwMDowMDowMDowMCwwMDowMDozMjoyMSwiQUQwMDY2MDFfRnVlbF90aGVfZmlyZV9TT05PVE9OLm1wMyIsMDA6MzI6MjEsIkFBIiwKMywwMDowMDo0MDowMCwwMDowMTo1NDoxNywiU0NEVjA4OTYwNV9CSVNfSU5fRElFX0VXSUdLRUlUX0FfU09OT1RPTi5tcDMiLDAxOjE0OjE3LCJOT05FIiwKNCwwMDowMjo0MDoyMCwwMDowMzowNzowOCwiQUQwMDY2MDFfRnVlbF90aGVfZmlyZV9TT05PVE9OLm1wMyIsMDA6MjY6MTMsIk5PTkUiLAo1LDAwOjAzOjI3OjAyLDAwOjA0OjA2OjE0LCJTQ0RWMTA4MjA5X0RFRVBMWV9DT05URU5URURfQV9TT05PVE9OLm1wMyIsMDA6Mzk6MTIsIkFBIiwKNiwwMDowNDoyNDoxOSwwMDowNzoxNDoyNCwiU1BSRTAwNDkyMl9SRUFTT05TX1NPTk9UT04ubXAzIiwwMjo1MDowNSwiTk9ORSIsCjcsMDA6MDc6MzI6MTEsMDA6MTA6Mzk6MTksIkRvbWluaWMgRmlrZSAtIDMgTmlnaHRzIChPZmZpY2lhbCBWaWRlbykubXAzIiwwMzowNzowOCwiQUEiLAo4LDAwOjExOjA1OjIyLDAwOjEzOjEyOjI0LCJBRDAwNjYwMV9GdWVsX3RoZV9maXJlX1NPTk9UT04ubXAzIiwwMjowNzowMiwiTk9ORSIsCg==",
        "file_size": 631,
    }
}

Export Formats

Use -F format={format} to define the output format. Possible values:

csv (separated by comma)
csv2 (separated by semicolon)
pdf
txt

Metadata from Music Library

Add -F library=1 to retrieve additional metadata for the music tracks. This option requires that your APIKEY is linked to a music library. This function is available for partners only.

Export Presets

Add -F preset=default to change the preset of a CSV export.

Marker Converter

This is the official API to our Marker Converter. All details about this tool can be found here: Marker Converter.

You need to be unlocked to use this API.

To convert a marker file the following command can be used:

curl -u "apikey:{YOUR_API_KEY}" -X POST -F format=csv -F [email protected]/path/to/myfile.edl "https://api.editingtools.io/marker"

Response (Example):

{
    "code": "200",
    "status": "OK",
    "data": {
        "created": "2022-08-14 21:21:43",
        "message": "Success",
        "file_name": "Marker.csv",
        "file_url": "https://editingtools.io/path/to/file/Marker.csv",
        "file_size": 631,
        "file_hash": "149350685432f7d03ab148cef3dfe926"
    }
}

You can download the generated file with wget or curl or embed it directly into your app from file_url. The generated file will be online for 20 minutes maximum. After download you can validate the file with MD5 HASH file_hash.

curl "https://editingtools.io/path/to/file/Marker.csv" --output Marker.csv

Instead of downloading the file you can recieve the file as base64 string. Add -F base64=1 to the request.

curl -u "apikey:{YOUR_API_KEY}" -X POST -F format=csv -F base64=1 -F [email protected]/path/to/myfile.edl "https://api.editingtools.io/marker"

Response (Example):

{
    "code": "200",
    "status": "OK",
    "data": {
        "created": "2022-08-14 21:21:43",
        "message": "Success",
        "file_name": "Marker.csv",
        "file_base64": "Tm8sVGltZWNvZGUgSW4sVGltZWNvZGUgT3V0LFRpdGxlLER1cmF0aW9uLFRyYWNrLE5vdGUKMiwwMDowMDowMDowMCwwMDowMDozMjoyMSwiQUQwMDY2MDFfRnVlbF90aGVfZmlyZV9TT05PVE9OLm1wMyIsMDA6MzI6MjEsIkFBIiwKMywwMDowMDo0MDowMCwwMDowMTo1NDoxNywiU0NEVjA4OTYwNV9CSVNfSU5fRElFX0VXSUdLRUlUX0FfU09OT1RPTi5tcDMiLDAxOjE0OjE3LCJOT05FIiwKNCwwMDowMjo0MDoyMCwwMDowMzowNzowOCwiQUQwMDY2MDFfRnVlbF90aGVfZmlyZV9TT05PVE9OLm1wMyIsMDA6MjY6MTMsIk5PTkUiLAo1LDAwOjAzOjI3OjAyLDAwOjA0OjA2OjE0LCJTQ0RWMTA4MjA5X0RFRVBMWV9DT05URU5URURfQV9TT05PVE9OLm1wMyIsMDA6Mzk6MTIsIkFBIiwKNiwwMDowNDoyNDoxOSwwMDowNzoxNDoyNCwiU1BSRTAwNDkyMl9SRUFTT05TX1NPTk9UT04ubXAzIiwwMjo1MDowNSwiTk9ORSIsCjcsMDA6MDc6MzI6MTEsMDA6MTA6Mzk6MTksIkRvbWluaWMgRmlrZSAtIDMgTmlnaHRzIChPZmZpY2lhbCBWaWRlbykubXAzIiwwMzowNzowOCwiQUEiLAo4LDAwOjExOjA1OjIyLDAwOjEzOjEyOjI0LCJBRDAwNjYwMV9GdWVsX3RoZV9maXJlX1NPTk9UT04ubXAzIiwwMjowNzowMiwiTk9ORSIsCg==",
        "file_size": 631,
    }
}