Skip to main content
POST
Generate a product

Authorizations

Authorization
string
header
required

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

Body

application/json
requestId
string
required

An ID you choose for this request, up to 128 characters. Retrying with the same requestId and body returns the original result.

Required string length: 1 - 128
prompt
string
required

What the product should look like, up to 1000 characters. In a jewelry category, name the options you want, such as the metal.

Required string length: 1 - 1000
categoryId
string
required

The category to make the product in, from categories/list.

Minimum string length: 1

Response

200 - application/json

OK

A product job; its result names the product once built

jobId
string
required

The job's ID. Pass it to jobs/get.

Minimum string length: 1
kind
enum<string>
required

What the job makes. pattern: started by patterns/create or a refine that returns a job. product: started by products/create or products/generate. download: started by an upscale in Arcade Studio.

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

A job starts as running and ends as succeeded or failed.

Available options:
running,
succeeded,
failed
result
object
required

What the job made, once it succeeded. Null while the job is running and when it failed. Also null on a succeeded job when a deformity fix found nothing to repair, or when the pattern has since been deleted.

error
object | null
required

Why the job failed. Null unless the job failed.

createdAt
string<date-time>
required

When the job started. For a product whose build was not recorded, when the product was created.

completedAt
string<date-time> | null
required

When the job finished. Null while the job is running, and for a failed product job.