Create an upload URL - Arcade API

POST

/

references

/

createUpload

Create an upload URL

curl --request POST \
  --url https://platform.arcade.ai/v1/references/createUpload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "byteLength": -4503599622127616
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({requestId: '<string>', byteLength: -4503599622127616})
};

fetch('https://platform.arcade.ai/v1/references/createUpload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://platform.arcade.ai/v1/references/createUpload"

payload = {
    "requestId": "<string>",
    "byteLength": -4503599622127616
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "uploadId": "<string>",
  "uploadUrl": "<string>",
  "method": "PUT",
  "requiredHeaders": {
    "Content-Type": "<string>"
  },
  "expiresAt": "2023-11-07T05:31:56Z"
}

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

mediaType

enum<string>

required

Content-Type of the file; references.create checks the bytes

Available options:

image/gif,

image/jpeg,

image/png,

image/webp

byteLength

integer

required

Declared file size, at most 10 MiB. The URL does not bind the size; references.create checks the stored bytes.

Required range: -9007199254740991 < x <= 10485760

Response

200 - application/json

OK

uploadId

string

required

From createUpload; valid only for the caller that created it

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)$

uploadUrl

string<uri>

required

Signed URL to PUT the file bytes to. Host not guaranteed.

method

any

required

requiredHeaders

object

required

Headers the PUT must send exactly; the signature binds them

Show child attributes

expiresAt

string<date-time>

required

The URL is rejected after this time

Create an upload URL

curl --request POST \
  --url https://platform.arcade.ai/v1/references/createUpload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "byteLength": -4503599622127616
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({requestId: '<string>', byteLength: -4503599622127616})
};

fetch('https://platform.arcade.ai/v1/references/createUpload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://platform.arcade.ai/v1/references/createUpload"

payload = {
    "requestId": "<string>",
    "byteLength": -4503599622127616
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "uploadId": "<string>",
  "uploadUrl": "<string>",
  "method": "PUT",
  "requiredHeaders": {
    "Content-Type": "<string>"
  },
  "expiresAt": "2023-11-07T05:31:56Z"
}