Listing and Pagination
The orders endpoint allows you to retrieve your orders with support for pagination using an offset. This enables you to efficiently navigate through large sets of orders. The endpoint supports per_page
and offset
query parameters. To retrieve orders with pagination, you must provide a valid API key.
Retrieving a list of orders with a set per page limit
const apiKey = "YOUR_API_KEY";
const perPage = 16;
const getOrders = async (perPage, apiKey) => {
const getOrdersResponse = await fetch(
`https://api.autoenhance.ai/v3/orders?per_page=${perPage}`,
{
method: "GET",
headers:{
"x-api-key": apiKey,
}
}
);
const { orders, pagination } = await getOrdersResponse.json();
}
As you can see, the response returns an orders, and pagination object. The orders object contains the list of your orders, and pagination contains two values: per_page, and next_offset.
Retrieving a paginated list of orders
If you want to load more orders with a pagination (next batch of orders without the initial orders that you've already fetched), you will need to use the next_offset value in your next request.
const apiKey = "YOUR_API_KEY";
const pagination = { per_page:16, next_offset:"string" };
const loadMoreOrders = async (perPage, nextOffset, apiKey) => {
const loadMoreOrdersResponse = await fetch(
`https://api.autoenhance.ai/v3/orders?per_page=${perPage}&offset=${nextOffset}`,
{
method: "GET",
headers:{
"x-api-key": apiKey,
}
}
);
const { orders, pagination } = await getOrdersResponse.json();
}
Specification
Lists the orders for the current user.
The offset token used to indicate which page of results to use.
0
The amount of items to be loaded per page of results. The final response may have a smaller number than requested if too large.
5
GET /v3/orders/ HTTP/1.1
Host: api.autoenhance.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
"orders": [
{
"created_at": "2025-07-05T18:47:47.134Z",
"images": [
{
"ai_version": "latest",
"cloud_type": "CLEAR",
"date_added": 1,
"downloaded": true,
"enhance": true,
"enhance_type": "property",
"finetune_settings": {},
"image_id": "123e4567-e89b-12d3-a456-426614174000",
"image_name": "text",
"lens_correction": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"order_id": null,
"privacy": true,
"rating": 1,
"scene": "text",
"sky_replacement": true,
"status": null,
"status_reason": null,
"upscale": true,
"user_id": null,
"vertical_correction": true,
"window_pull": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"is_deleted": true,
"is_merging": true,
"is_processing": true,
"last_updated_at": "2025-07-05T18:47:47.134Z",
"name": "text",
"order_id": "text",
"status": null,
"total_images": 1
}
],
"pagination": {
"next_offset": "text",
"per_page": 5
}
}
Last updated