Skip to main content
POST
Retrieve a pattern

Authorizations

Authorization
string
header
required

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

Body

application/json
patternId
string
required

The pattern's ID. A pattern never changes: a refine makes a new pattern with a new ID.

Minimum string length: 1

Response

200 - application/json

OK

imageUrl
string<uri>
required

URL of the image. It expires; call the endpoint again for a fresh one. The host can change.

thumbnailUrl
string<uri>
required

URL of a small version of the image. It expires like imageUrl.

width
integer
required

Width of the image in pixels.

Required range: -9007199254740991 < x <= 9007199254740991
height
integer
required

Height of the image in pixels.

Required range: -9007199254740991 < x <= 9007199254740991
patternId
string
required

The pattern's ID. A pattern never changes: a refine makes a new pattern with a new ID.

Minimum string length: 1
prompt
string | null
required

The prompt the pattern was generated from. A refined pattern keeps the prompt of its original. Null for uploaded artwork.

sourcePatternId
string | null
required

For a refined pattern, the pattern it was made from. Null for a generated or uploaded pattern.

Minimum string length: 1
createdAt
string<date-time>
required

When the pattern was made.

repeatDrop
enum<string>

How the pattern repeats. Each column of tiles is shifted down from the one before it by this fraction of the tile height: none, half, quarter or eighth. The tile itself stays square.

Available options:
none,
half,
quarter,
eighth