Skip to main content
You can upload two kinds of image:
  • Artwork becomes a pattern. Make products from it or refine it, like a generated pattern.
  • A reference guides a generation or an edit. Pass it to patterns/create or patterns/refine/edit.
Both use the same three steps. Only the endpoint names differ. Files can be JPEG, PNG, WebP or GIF, up to 10 MiB.
1

Get an upload URL

Call patterns/createUpload with the file’s media type and size in bytes.
cURL
2

Send the file

PUT the file to uploadUrl before expiresAt. Send every header in requiredHeaders, exactly as returned.
cURL
Don’t send your API key with this request. The URL is already signed.
3

Save the upload

Call patterns/upload with the uploadId and a new requestId.
cURL
The response is the pattern itself, not a job. Among other fields, it includes:
Use the patternId in products/create or in a refine.

Use a reference

Upload a reference with references/createUpload and references/create, then pass its referenceId:
  • In referenceIds on patterns/create, to guide a new pattern.
  • As referenceId on patterns/refine/edit, to guide an edit.

Retries

Saving the same uploadId again returns the same pattern or reference. It never makes a duplicate. See Idempotency.