Skip to main content
Jewelry works differently from print products. You describe the piece in a prompt, and one call generates the finished product. There is no pattern step.
1

Get an API key

Create a key in Arcade Studio under Settings → API keys, then export it.
Every sample sends a User-Agent header that names your integration and a contact. Replace it with your own; see Identify your client.
2

Choose a jewelry category

A category is a type of product. List the categories and choose one whose world is jewelry.
category is the group the category belongs to. Category IDs can change. Read them from categories/list; don’t hardcode them.
3

Generate the piece

Call products/generate with a prompt and the categoryId. Each call makes one product.Arcade picks the product’s options, such as the metal, from your prompt. Name the ones you want. categories/get lists the options a category has.The requestId is an ID you choose; it makes the request safe to retry. See Idempotency.
The response is a job:
If the prompt clearly doesn’t fit the category, such as a necklace prompt in a ring category, the request returns 400 and no job starts. Change the prompt or the category and try again.
4

Wait for the job

Call jobs/get every 10 seconds until status is succeeded or failed. The job finishes when the product is built.
result.productId is your product.If the job failed, error.message says why. One cause is that no maker can price the design. In that case, try a different metal or prompt, with a new requestId.
5

Review the product

Call products/get to see the product’s images, options and price.
Among other fields, the response includes:
selections holds the options Arcade picked from your prompt. unitPrice is the price of one piece.You can’t edit a jewelry product. To change the piece, call products/generate again with a revised prompt and a new requestId.
6

Get a dropshipping quote

An order for a single piece uses dropshipping, which costs credits unless the cost is waived. Get the current cost before you create the checkout.
creditCost is what this order will cost you in credits. It is 0 when the cost is waived, for example when your plan includes dropshipping.
7

Order it

Create a checkout with "dropShip": true. Pass the quote’s creditCost as expectedDropshippingCreditCost and its revision, as a number, as expectedDropshippingPolicyRevision. Then open checkoutUrl to pay.
After payment, orders/get with the checkoutId returns the order. It can return 404 for a short time right after payment; try again shortly.

What you can’t do with jewelry

A jewelry product’s image is not a pattern. These calls return 400 for it:
  • patterns/get. Read the images with products/get instead.
  • Every refine, such as patterns/refine/edit.
  • products/create, and using the image as a reference.
patterns/list doesn’t list jewelry images. Use products/list.