Creating

This API endpoint allows you to create orders. To create an order, you must provide a valid API key.

Pro tip You don't need to create an order before you upload your images. Order is already created in the flow of creating images even if you don't specify an order_id to it, but it might be handy to have it ready when uploading multiple or HDR images.

Important note You can assign a name and a custom order_id to an order. Be careful though, the order_id has to be unique, and we will generate it and return it to you in the response from our API.

JavaScript

const apiKey = "YOUR_API_KEY";

const createOrder = async (apiKey) => {
    const createOrderResponse = await fetch(
      "https://api.autoenhance.ai/v3/orders",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
          "x-api-key": apiKey,
        },
        body: JSON.stringify({
          name:"Name of my order"
        }),
      }
    );

    const { order_id, name, images, status } = await createOrderResponse.json();
}

Python

import requests

api_key = "YOUR_API_KEY"

def create_order(api_key):
    url = "https://api.autoenhance.ai/v3/orders"
    headers = {
        "Content-Type": "application/json",
        "x-api-key": api_key,
    }
    payload = {
        "name": "Name of my order"
    }
    
    response = requests.post(url, headers=headers, json=payload)
    response_data = response.json()
    
    order_id = response_data.get('order_id')
    name = response_data.get('name')
    images = response_data.get('images')
    status = response_data.get('status')

    return order_id, name, images, status

PHP

$api_key = "YOUR_API_KEY";

function create_order($api_key) {
    $url = "https://api.autoenhance.ai/v3/orders";

    $data = array(
        'name' => 'Name of my order'
    );

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $api_key",
            'method'  => 'POST',
            'content' => json_encode($data)
        )
    );

    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error creating order';
    }

    $order_details = json_decode($result, true);
    return $order_details;
}

cURL

curl -X POST \
  'https://api.autoenhance.ai/v3/orders' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
        "name": "Name of my order"
    }'

The response after successfully creating an order will contain all the details of your order. The status will be 'waiting' until you add images to it.

Specification

Create Order

POSThttps://api.autoenhance.ai//v3/orders/

Authorization

ApiKeyAuth

Body

application/json

namestring

The name for the order.

order_idstring

The ID for the order.

Response

200401422

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.autoenhance.ai//v3/orders/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401422

{
  "message": "text"
}