Skip to main content
POST
Create a reference

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
uploadId
string
required

The uploadId from references/createUpload, after you have sent the file.

Pattern: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\.(gif|jpg|png|webp)$

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
mediaType
enum<string>
required

The image's media type.

Available options:
image/gif,
image/jpeg,
image/png,
image/webp
referenceId
string
required

The reference image's ID.

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

When the reference was saved.

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