QS Build APIs

Sessions

get

/v{version}/Session/current

Authorizations

Path parameters

versionstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v{version}/Session/current' \
  --header 'Authorization: YOUR_API_KEY'

200

200

No body

Success

delete

/v{version}/Session/current

Authorizations

Path parameters

versionstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v{version}/Session/current' \
  --header 'Authorization: YOUR_API_KEY'

200

200

No body

Success

post

/v{version}/Session

Authorizations

Path parameters

versionstringrequired

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v{version}/Session' \
  --header 'Authorization: YOUR_API_KEY'

200

200

text/plain

application/json

text/json

text/plain

{
  "sessionId": "text",
  "expiresIn": 1,
  "credentials": {
    "token": "text",
    "id": "text",
    "pseudonym": "text",
    "role": "text"
  },
  "rules": {
    "maxFiles": 1,
    "maxUsers": 1,
    "maxTotalMegaBytes": 1
  }
}

Success

post

/v{version}/Session/{sessionId}/join

Authorizations

Path parameters

sessionIdstringrequired

versionstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v{version}/Session/{sessionId}/join' \
  --header 'Authorization: YOUR_API_KEY'

200

200

No body

Success

post

/v{version}/Session/current/kick

Authorizations

Path parameters

versionstringrequired

Body

application/jsontext/jsonapplication/*+json

userIdstring | nullable

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v{version}/Session/current/kick' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "text"
  }'

200

200

No body

Success

Decentralized Buckets

get

/v{version}/Buckets

Authorizations

Path parameters

versionstringrequired

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v{version}/Buckets' \
  --header 'Authorization: YOUR_API_KEY'

200

200

text/plain

application/json

text/json

text/plain

[
  {
    "creatorId": "text",
    "completed": true,
    "fileId": "text",
    "fileName": "text",
    "totalParts": 1
  }
]

Success

post

/v{version}/Buckets

Authorizations

Path parameters

versionstringrequired

Body

application/jsontext/jsonapplication/*+json

totalPartsinteger · int32

encryptedNamestring | nullable

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v{version}/Buckets' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "totalParts": 1,
    "encryptedName": "text"
  }'

200

200

text/plain

application/json

text/json

text/plain

{
  "uploadId": "text",
  "fileKey": "text"
}

Success

put

/v{version}/Buckets

Authorizations

Path parameters

versionstringrequired

Header parameters

partNumberinteger · int32

keystring

uploadIdstring

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v{version}/Buckets' \
  --header 'Authorization: YOUR_API_KEY'

200

200

text/plain

application/json

text/json

text/plain

{
  "tag": "text"
}

Success

post

/v{version}/Buckets/complete

Authorizations

Path parameters

versionstringrequired

Header parameters

keystring

Body

application/jsontext/jsonapplication/*+json

tagsstring[] | nullable

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v{version}/Buckets/complete' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "tags": [
      "text"
    ]
  }'

200

200

text/plain

application/json

text/json

text/plain

{
  "uploadId": "text",
  "fileKey": "text"
}

Success

delete

/v{version}/Buckets/{fileId}

Authorizations

Path parameters

fileIdstringrequired

versionstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v{version}/Buckets/{fileId}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

No body

Success

get

/v{version}/Buckets/download/{fileId}

Authorizations

Path parameters

fileIdstringrequired

versionstringrequired

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v{version}/Buckets/download/{fileId}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

text/plain

application/json

text/json

text/plain

{
  "url": "text"
}

Success

More APIs coming soon