Using the API key you generated you can use it to authenticate with the API.

Authentication method

The API key you use to authenticate should be kept a secret and only be used on a server side not via the client. Exposing this key could cause bad things to happen.

Authentication method used is Bearer token.

Add the token in your request header

Authentication: Bearer <token>

JavaScript example

import axios from 'axios';
axios.defaults.baseURL = '';
axios.defaults.headers.common = { 'Authorization': 'Bearer Xmwm2j3EPqQOY51F1QfU6aqFHDQsB1nSTGxxII1a3c5MSYULoVBbHKZ1UL3yxntBETADT' };

// example usage
let orders = await axios.get('/orders');

Request headers

This is a JSON API, make sure you set these headers.

Accept: application/json
Content-Type: application/json

Rate limits - Error code 429

60 requests per minute.

Rate limit headers will be returned on each request. E.g.

X-RateLimit-Limit: 15
X-RateLimit-Remaining: 14

If you require a higher rate limit, then please contact us.

Error responses

401 - Unauthorized

Your API key is not valid. The key is incorrect or has been revoked.

402 - Upgrade required

Storage limit has been reached, upgrade your plan for more space.

404 - Not found

The resource you are trying to access can not be found.

422 - Validation error

Validation error.

Example response when creating a URL asset

    "message": "The filename is required. (and 3 more errors)",
    "errors": {
        "filename": [
            "The filename field is required.",
            "The filename name must be a string.",
            "The filename must be not be more than 255 characters."
        "size": [
            "The size field is required."
        "url": [
            "The url field is required."

500 - Server error

All server errors will be directly reported to us automatically. If the problem persists please contact us.

Getting started