Request document upload URL

POST

uploads

document-file

curl --request POST \
  --url https://api.squadvault.xyz/v1/uploads/document-file \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "organizationId": "org_example",
  "contentType": "application/pdf",
  "sizeBytes": 102400
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    organizationId: 'org_example',
    contentType: 'application/pdf',
    sizeBytes: 102400
  })
};

fetch('https://api.squadvault.xyz/v1/uploads/document-file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.squadvault.xyz/v1/uploads/document-file"

payload = {
    "organizationId": "org_example",
    "contentType": "application/pdf",
    "sizeBytes": 102400
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "key": "<string>",
  "fileRef": "<string>",
  "uploadUrl": "<string>"
}

Authorizations

x-api-key

string

header

required

Organization API key from Settings → API keys.

Body

application/json

organizationId

string

required

contentType

enum<string>

required

Available options:

application/pdf,

application/msword,

application/vnd.openxmlformats-officedocument.wordprocessingml.document,

application/vnd.ms-excel,

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,

text/plain,

image/jpeg,

image/png,

image/webp,

image/gif

sizeBytes

integer

required

Exact file size in bytes (enforced on the presigned PUT)

Required range: x >= 1

Response

Presigned upload details

key

string

required

Use as fileKey when creating the document

fileRef

string

required

Opaque private storage reference to send as fileUrl (not a public HTTP URL)

uploadUrl

string<uri>

required

Presigned PUT URL for the file bytes

Request document upload URL

curl --request POST \
  --url https://api.squadvault.xyz/v1/uploads/document-file \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "organizationId": "org_example",
  "contentType": "application/pdf",
  "sizeBytes": 102400
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    organizationId: 'org_example',
    contentType: 'application/pdf',
    sizeBytes: 102400
  })
};

fetch('https://api.squadvault.xyz/v1/uploads/document-file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.squadvault.xyz/v1/uploads/document-file"

payload = {
    "organizationId": "org_example",
    "contentType": "application/pdf",
    "sizeBytes": 102400
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "key": "<string>",
  "fileRef": "<string>",
  "uploadUrl": "<string>"
}

Guides

Teams

Players

Documents

Tryout Applications

Uploads

Request document upload URL

Authorizations

Body

Response