Skip to main content
POST
Optional. Create Try-On already creates products inline. Use this endpoint only to register products ahead of time, keep them forever, or list them in GET /products.
Creates or updates the product with this externalId. Products created here never expire unless you set validForDays. On update, omitted fields keep their value. The product is analyzed right away, so its first try-on skips that step and returns faster. Registering products before shoppers or users reach them is the quickest setup. Send JSON, or multipart/form-data with the JSON in a data field when you upload image bytes.

Body

string
required
Your product ID. Can’t start with _anon_.
string
Product name. Send the full title: it helps the AI.
string
Product description (cut, fit, length). Helps the AI.
array
[{ source: { url } }] or [{ source: { fileKey } }]. Required on create. Replaces the whole list on update.
integer | null
default:"null"
Lifetime after last use, 1 to 365 days. null keeps it forever.
object
Any JSON, returned on GET /products/:externalId.

Response

The product. Fields are listed on List, Get & Delete Products.