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

Caller-chosen idempotency key; a replay returns the original result

Required string length: 1 - 128
uploadId
string
required

From references.createUpload, once the file was PUT

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

Short-lived; read again to renew. Host not guaranteed.

thumbnailUrl
string<uri>
required
width
integer
required
Required range: -9007199254740991 < x <= 9007199254740991
height
integer
required
Required range: -9007199254740991 < x <= 9007199254740991
mediaType
enum<string>
required
Available options:
image/gif,
image/jpeg,
image/png,
image/webp
referenceId
string
required

Opaque ID of one uploaded reference image

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