AI Shoot

Use the AI Shoot API to manage SKUs and retrieve brief results for your shoots.

Getting started

If you’re new to AI Shoot, see Create your first AI Shoot to understand the workflow using the Web App before integrating via API.

Note

All the AI Shoot API endpoints require a valid bearer token. Requests will automatically run under the organization tied to your token, so make sure you’re authenticated with the right organization before calling these endpoints.

Beta

The AI Shoot API is currently in beta and under active development. Endpoints, request/response formats, and behavior may change without prior notice. We recommend checking this documentation regularly for updates.

---

SKUs

List SKUs

GET https://api.autoretouch.com/ai-shoot/skus

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number
pageSize	integer	No	Number of items per page
projectFilter	string	No	Filter SKUs by project
skuIdFilter	string	No	Filter by SKU ID

Request

curl

curl -X GET "https://api.autoretouch.com/ai-shoot/skus?page=1&pageSize=20" \
  -H "Authorization: Bearer {accessToken}"

Python

import requests

response = requests.get(
    "https://api.autoretouch.com/ai-shoot/skus",
    params={"page": 1, "pageSize": 20},
    headers={"Authorization": f"Bearer {access_token}"}
)

data = response.json()
print(data)

---

List Global SKUs

GET https://api.autoretouch.com/ai-shoot/skus/global

Returns globally available SKUs for the organization. No additional query parameters.

Request

curl

curl -X GET "https://api.autoretouch.com/ai-shoot/skus/global" \
  -H "Authorization: Bearer {accessToken}"

Python

import requests

response = requests.get(
    "https://api.autoretouch.com/ai-shoot/skus/global",
    headers={"Authorization": f"Bearer {access_token}"}
)

data = response.json()
print(data)

---

Create SKU

POST https://api.autoretouch.com/ai-shoot/skus

Returns 201 Created on success.

Request Body

Field	Type	Required	Description
name	string	Yes	SKU name (non-blank)
frontImage	string	Yes	Front image identifier (non-blank)
backImage	string	No	Back image identifier
gender	string	No	Gender of the SKU. Possible values: male, female
isInWardrobe	boolean	No	Whether the SKU is in the wardrobe
projectIds	integer[]	No	List of project IDs to associate (positive integers)
skuCategoryName	string	No	SKU category. Possible values: top, bottom, outfit, socks, shoes, hats

Note

The frontImage and backImage identifiers must be content hashes returned by the POST /upload endpoint.

Request

curl

curl -X POST "https://api.autoretouch.com/ai-shoot/skus" \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Blue Shirt",
    "frontImage": "image-identifier-front",
    "gender": "male",
    "projectIds": [1, 2],
    "skuCategoryName": "top"
  }'

Python

import requests

response = requests.post(
    "https://api.autoretouch.com/ai-shoot/skus",
    headers={
        "Authorization": f"Bearer {access_token}",
        "Content-Type": "application/json"
    },
    json={
        "name": "Blue Shirt",
        "frontImage": "image-identifier-front",
        "gender": "male",
        "projectIds": [1, 2],
        "skuCategoryName": "top"
    }
)

sku = response.json()
print(sku)

---

Update SKU

PUT https://api.autoretouch.com/ai-shoot/skus/{skuId}

Path Parameters

Parameter	Type	Description
skuId	string	ID of the SKU to update

Request Body

Field	Type	Required	Description
name	string	Yes	SKU name (non-blank)
frontImage	string	Yes	Front image identifier (non-blank)
backImage	string	No	Back image identifier
gender	string	No	Gender. Possible values: male, female
isInWardrobe	boolean	No	Defaults to false if omitted
projectIds	integer[]	No	Defaults to empty list if omitted
skuCategoryName	string	No	SKU category. Possible values: top, bottom, outfit, socks, shoes, hats

Note

The frontImage and backImage identifiers must be content hashes returned by the POST /upload endpoint.

Request

curl

curl -X PUT "https://api.autoretouch.com/ai-shoot/skus/{skuId}" \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Blue Shirt Updated",
    "frontImage": "image-identifier-front",
    "skuCategoryName": "top"
  }'

Python

import requests

response = requests.put(
    f"https://api.autoretouch.com/ai-shoot/skus/{sku_id}",
    headers={
        "Authorization": f"Bearer {access_token}",
        "Content-Type": "application/json"
    },
    json={
        "name": "Blue Shirt Updated",
        "frontImage": "image-identifier-front",
        "skuCategoryName": "top"
    }
)
print(response.status_code)

---

Delete SKU

DELETE https://api.autoretouch.com/ai-shoot/skus/{skuId}

Path Parameters

Parameter	Type	Description
skuId	string	ID of the SKU to delete

Request

curl

curl -X DELETE "https://api.autoretouch.com/ai-shoot/skus/{skuId}" \
  -H "Authorization: Bearer {accessToken}"

Python

import requests

response = requests.delete(
    f"https://api.autoretouch.com/ai-shoot/skus/{sku_id}",
    headers={"Authorization": f"Bearer {access_token}"}
)
print(response.status_code)

---

Brief Results

Get Brief Results

GET https://api.autoretouch.com/ai-shoot/briefs/{briefId}/results

Path Parameters

Parameter	Type	Description
briefId	integer	ID of the brief

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number
pageSize	integer	No	Items per page

Request

curl

curl -X GET "https://api.autoretouch.com/ai-shoot/briefs/{briefId}/results?page=1&pageSize=20" \
  -H "Authorization: Bearer {accessToken}"

Python

import requests

response = requests.get(
    f"https://api.autoretouch.com/ai-shoot/briefs/{brief_id}/results",
    params={"page": 1, "pageSize": 20},
    headers={"Authorization": f"Bearer {access_token}"}
)

results = response.json()
print(results)