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.

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();
}

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

$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;
}

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

post

Authorizations

x-api-keystringRequired

Body

default_image_sort_orderundefined · enumOptional

Default sort order for images in the order. Prefix with '-' for descending order.

Possible values:

namestringOptional

The name for the order.

order_idstringOptional

The ID for the order.

Responses

200

Successful response

application/json

Responseany

401

Authentication error

application/json

422

Validation error

application/json

post

/v3/orders/

POST /v3/orders/ HTTP/1.1
Host: api.autoenhance.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "default_image_sort_order": "name",
  "name": "text",
  "order_id": "text"
}

No content

PreviousManaging Orders NextEditing

Last updated 1 year ago

Was this helpful?

hashtagSpecification

hashtagCreate Order

Specification

Create Order