Skip to main content

Aistetic Listing API Documentation

Overview​

This document outlines the implementation details of Aistetic's Listing API, which consists of two primary endpoints for garment tagging, measurements, and descriptions.

Key Details​

  • Rate Limit: 6 requests per minute
  • Versioning Policy: Only the latest version is supported
  • Release Cycle: Updates and fixes 2-4 times a month, typically on Fridays

System Overview​

The Aistetic API system consists of several components working together to process garment images and provide tagging, measurements, and descriptions.

System Diagram

Base URL​

https://api.aistetic.com/garment-tagging

Authentication​

Authentication requires an API key and domain name, which must be created in the Aistetic dashboard. For detailed setup instructions, see our Getting Started Guide.

Authentication Headers​

HeaderTypeDescription
API-KEYStringRequired API key for authentication
DOMAINStringDomain name registered in the dashboard

Response Structure​

All API responses follow a standard format:

{
    "status": true|false,
    "data": { ... },
    "error": [],
    "message": "success!"|"error message"
}
  • status: Boolean indicating success or failure
  • data: Contains the response data
  • error: Array of error messages (if any)
  • message: Description of the response status

Endpoints​

1. Upload Garment Image​

Endpoint​

POST /upload

Description​

Uploads an image of a garment with metadata for tagging.

Request Headers​

  • Content-Type: application/json
  • API-KEY: {{api_key}}
  • DOMAIN: {{domain}}

Request Body Example​

{
 "uuid": "{{uuid}}",
 "image_url": "https://s3.amazonaws.com/path/to/image.jpg",
 "attribute": {
   "Brand": "Stone Island",
   "Category": "Clothing",
   "Gender": "Women's",
   "Material": "Cotton",
   "Studio": "18"
 }
}

Response​

{
 "status": true,
 "data": {},
 "error": [],
 "message": "success!"
}

Notes​

  • uuid is a unique identifier for tracking the request
  • image_url should be a publicly accessible link
  • The attribute object contains garment metadata

2. Retrieve Garment Tagging Details​

Endpoint​

GET /query?uuid={{uuid}}

Description​

Fetches tagging details for a previously uploaded garment image using the UUID.

Request Headers​

  • API-KEY: {{api_key}}
  • DOMAIN: {{domain}}

Request Parameters​

  • uuid (String): Unique identifier for query

Responses​

When Data Processing is Complete:​
{
 "status": true,
 "data": {
   "uuid": "976",
   "annotated_img": "https://s3.amazonaws.com/path/to/annotated_image.jpg",
   "tag": {
     "Brand": "Stone Island",
     "Category": "Clothing",
     "Closure": "Button",
     "Closure Alternatives": [
       "Drawstring",
       "Snap",
       "Zip"
     ],
     "Closure Confidence": "High",
     "Colour": "Blue",
     "Colour Alternatives": [
       "Grey",
       "Black",
       "Turquoise"
     ],
     "Colour Confidence": "High",
     "Fabric Type": "Denim",
     "Fabric Type Alternatives": [
       "Canvas",
       "Knit",
       "Corduroy"
     ],
     "Fabric Type Confidence": "High",
     "Fit": "Slim",
     "Fit Alternatives": [
       "Relaxed",
       "Regular",
       "Athletic"
     ],
     "Fit Confidence": "High",
     "Gender": "Womens",
     "Item Type": "Skinny Jeans",
     "Item Type Alternatives": [
       "Straight Jeans",
       "Bootcut Jeans",
       "High Waist Jeans"
     ],
     "Item Type Confidence": "High",
     "Material": "Cotton"
   },
   "measurements": {
     "Length (inches)": 29,
     "Rise (inches)": 11,
     "Waist (inches)": 29
   },
   "description": "These Stone Island women's skinny jeans are crafted from high-quality cotton denim, offering both comfort and style.",
   "complete": true
 },
 "error": [],
 "message": "success!"
}
When Data is Still Processing:​
{
 "status": true,
 "data": {
   "uuid": "976",
   "annotated_img": "",
   "tag": null,
   "measurements": null,
   "description": "",
   "complete": false
 },
 "error": [],
 "message": "success!"
}

Notes:​

  • When "complete" is true, the response contains full tagging details, measurements, and description
  • When "complete" is false, the response contains empty values, indicating the data is still being processed

Processing Status Values​

When querying the status of a processing task, you'll receive one of these status values:

  • queuing: The request is in the queue waiting to be processed
  • processing: The request is currently being processed
  • complete: Processing has completed successfully
  • failed: Processing encountered an error and failed

Additional Resources​