Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

An API key from Settings → API keys in Arcade Studio.

Body

application/json
requestId
string
required

Caller-chosen idempotency key; a replay returns the original result

Required string length: 1 - 128
patternId
string
required

The pattern to make it from

Minimum string length: 1
categoryId
string
required

Category ID, from categories.list

Minimum string length: 1
selections
object
required

The complete selection, as categories.get returns it

fit
object

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.

Response

200 - application/json

OK

A product job; its result names the product once built

jobId
string
required

Opaque job ID; read the job with jobs.get

Minimum string length: 1
kind
enum<string>
required

What the job makes: a pattern (patterns.create or a refine), a product (products.create) or a download (an upscale started in Arcade Studio)

Available options:
pattern,
product,
download
status
enum<string>
required

Jobs are created running; there is no queued state

Available options:
running,
succeeded,
failed
result
object
required

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.

error
object | null
required

Why the job failed; set once it failed

createdAt
string<date-time>
required

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

completedAt
string<date-time> | null
required

When the job finished; null while running and for a failed product job, which does not record it