Create a product
Starts a job that builds a product from a pattern, a category and its options. On success, result.productId is the new product.
Authorizations
An API key from Settings → API keys in Arcade Studio.
Body
Caller-chosen idempotency key; a replay returns the original result
1 - 128The pattern to make it from
1Category ID, from categories.list
1The complete selection, as categories.get returns it
How the pattern fits the product; required when the pattern's aspect ratio does not match the selected size. A crop is in the pattern's pixels.
- Option 1
- Option 2
Response
OK
A product job; its result names the product once built
Opaque job ID; read the job with jobs.get
1What the job makes: a pattern (patterns.create or a refine), a product (products.create) or a download (an upscale started in Arcade Studio)
pattern, product, download Jobs are created running; there is no queued state
running, succeeded, failed What a succeeded job made. Null while running, when it failed, when a deformity fix found nothing to repair, and once the pattern it made is deleted.
- Option 1
- Option 2
- Option 3
Why the job failed; set once it failed
When the job started; for a product with no recorded build (made by Create, or built before builds were kept), when the product was created
When the job finished; null while running and for a failed product job, which does not record it