# Arcade API

- [Introduction](https://docs.arcade.ai/index.md): From your imagination to your doorstep.
- [Quickstart](https://docs.arcade.ai/quickstart.md): Generate a pattern and order it as a product.
- [Authentication](https://docs.arcade.ai/authentication.md): Authenticate requests with an API key.
- [Idempotency](https://docs.arcade.ai/idempotency.md): Retry requests safely.
- [Jobs](https://docs.arcade.ai/jobs.md): Track long-running work.
- [Pagination](https://docs.arcade.ai/pagination.md): Page through list results.
- [Errors](https://docs.arcade.ai/errors.md): Error responses and how to handle them.
- [Create a pattern](https://docs.arcade.ai/api-reference/patterns/create-a-pattern.md): Starts a job that generates a pattern from a prompt. On success, `result.patternId` is the new pattern.
- [Retrieve a pattern](https://docs.arcade.ai/api-reference/patterns/retrieve-a-pattern.md): Retrieves a pattern. Image URLs are short-lived; retrieve the pattern again to renew them.
- [List patterns](https://docs.arcade.ai/api-reference/patterns/list-patterns.md): Lists your patterns, newest first.
- [Edit a pattern](https://docs.arcade.ai/api-reference/refine/edit-a-pattern.md): Starts a job that edits a pattern from a text instruction.
- [Edit a region](https://docs.arcade.ai/api-reference/refine/edit-a-region.md): Starts a job that edits only the masked area of a pattern.
- [Retrieve color clusters](https://docs.arcade.ai/api-reference/refine/retrieve-color-clusters.md): Lists a pattern's dominant colors, to choose replacements for `recolor`.
- [Recolor a pattern](https://docs.arcade.ai/api-reference/refine/recolor-a-pattern.md): Starts a job that replaces a pattern's dominant colors.
- [Crop a pattern](https://docs.arcade.ai/api-reference/refine/crop-a-pattern.md): Starts a job that crops a pattern to a rectangle.
- [Make a pattern seamless](https://docs.arcade.ai/api-reference/refine/make-a-pattern-seamless.md): Starts a job that turns a square region into a seamless repeat.
- [Extend a pattern](https://docs.arcade.ai/api-reference/refine/extend-a-pattern.md): Starts a job that extends a repeating pattern to a larger size.
- [Extend a scene](https://docs.arcade.ai/api-reference/refine/extend-a-scene.md): Starts a job that extends a non-repeating image beyond its edges.
- [Fix deformities](https://docs.arcade.ai/api-reference/refine/fix-deformities.md): Starts a job that detects and repairs malformed details in a pattern.
- [Retrieve a job](https://docs.arcade.ai/api-reference/jobs/retrieve-a-job.md): Retrieves a job. Poll until `status` is `succeeded` or `failed`.
- [Create an upload URL](https://docs.arcade.ai/api-reference/references/create-an-upload-url.md): Returns a signed URL to upload a reference image to. `PUT` the file, then call `references/create`.
- [Create a reference](https://docs.arcade.ai/api-reference/references/create-a-reference.md): Saves an uploaded image as a reference for `patterns/create`.
- [Retrieve a reference](https://docs.arcade.ai/api-reference/references/retrieve-a-reference.md): Retrieves a reference image.
- [List references](https://docs.arcade.ai/api-reference/references/list-references.md): Lists your references, newest first.
- [List models](https://docs.arcade.ai/api-reference/models/list-models.md): Lists the models you can generate patterns with.
- [List categories](https://docs.arcade.ai/api-reference/categories/list-categories.md): Lists the product categories available to order.
- [Retrieve a category](https://docs.arcade.ai/api-reference/categories/retrieve-a-category.md): Retrieves a category and its options. Not every combination of option values can be made: send the values you have decided, in any number, and each value comes back with `available`, whether some product that can be made has that value together with every value you sent for the other options.
- [Create a product](https://docs.arcade.ai/api-reference/products/create-a-product.md): Starts a job that builds a product from a pattern, a category and its options. On success, `result.productId` is the new product.
- [Retrieve a product](https://docs.arcade.ai/api-reference/products/retrieve-a-product.md): Retrieves a product with its images, maker and price. Pass `quantity` to price that quantity.
- [List products](https://docs.arcade.ai/api-reference/products/list-products.md): Lists your products, newest first.
- [Create a checkout](https://docs.arcade.ai/api-reference/checkouts/create-a-checkout.md): Creates a checkout for your products. Open `checkoutUrl` to pay; the order is placed once payment completes.
- [Retrieve an order](https://docs.arcade.ai/api-reference/orders/retrieve-an-order.md): Retrieves an order by `orderId`, or by `checkoutId` once the checkout is paid. Returns `404` until then.
- [List orders](https://docs.arcade.ai/api-reference/orders/list-orders.md): Lists your orders, newest first.

## OpenAPI Specs

- [openapi](/openapi.json)