Upload API

API for session storage with a simplified interface for uploading and managing content on IPFS storage

This page provides comprehensive documentation for the Upload API, which offers a simplified interface for uploading and managing content on IPFS (InterPlanetary File System) storage. Inspired by the widely adopted S3 API, this interface aims to provide a familiar experience for developers while leveraging the benefits of decentralized storage. By abstracting the underlying complexity of IPFS, the API allows for seamless integration into existing workflows with minimal learning curve.

This API is currently under active development and may be subject to changes. We recommend reviewing the documentation regularly and subscribing to updates to stay informed about any modifications, deprecations, or new features that may affect your integration.

The maximum upload size and related limitations are governed by the rules defined for each session

Retrieve all files in the user's storage bucket

get

Returns a list of files currently stored in the authenticated user's bucket. Useful for listing uploaded content.

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Responses

200

Success

text/plainapplication/jsontext/json

creatorIdstring · nullableOptional

completedbooleanOptional

fileKeystring · nullableOptional

fileNamestring · nullableOptional

totalPartsinteger · int32Optional

originalSizeInBytesinteger · int64Optional

get

/buckets

HTTPcURLJavaScriptPython

GET /v1/buckets HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

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

Start a new file upload

post

Initiates a multipart upload request to the user's storage bucket. Returns necessary upload details including an uploadId. For using with QS Share, encryptedName should be encrypted using AES256 with the session ID as key

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Body

application/jsontext/jsonapplication/*+json

totalPartsinteger · int32Optional

encryptedNamestring · nullableOptional

originalSizeInBytesinteger · int64Optional

Responses

200

Success

text/plainapplication/jsontext/json

uploadIdstring · nullableOptional

fileKeystring · nullableOptional

post

/buckets

HTTPcURLJavaScriptPython

POST /v1/buckets HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "totalParts": 1,
  "encryptedName": "text",
  "originalSizeInBytes": 1
}

application/jsontext/jsonapplication/*+json

200

Success

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

Upload a file part for multipart upload

put

Uploads a specific part of a file during a multipart upload. Requires uploadId, partNumber, and key to identify the upload session and part.

Authorizations

API Key & Session Bearer & Wallet Ownership Bearer

X-API-KEYstringRequired

API key issued for beta developers for creating/joining sessions.

AuthorizationstringRequired

Bearer schema token issued by session credentials

AuthorizationstringRequired

Bearer schema token issued by wallet verification.

Header parameters

partNumberinteger · int32Optional

keystringOptional

uploadIdstringOptional

Responses

200

Success

text/plainapplication/jsontext/json

tagstring · nullableOptional

partNumberinteger · int32Optional

put

/buckets

HTTPcURLJavaScriptPython

PUT /v1/buckets HTTP/1.1
Host: api.quicksync.me
X-API-KEY: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "tag": "text",
  "partNumber": 1
}

Finalize a multipart file upload.

post

Completes a multipart file upload by combining previously uploaded parts. Requires the uploadId and associated metadata to finalize the upload.

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Body

application/jsontext/jsonapplication/*+json

tagsstring[] · nullableOptional

keystring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

uploadIdstring · nullableOptional

fileKeystring · nullableOptional

post

/buckets/complete

HTTPcURLJavaScriptPython

POST /v1/buckets/complete HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "tags": [
    "text"
  ],
  "key": "text"
}

application/jsontext/jsonapplication/*+json

200

Success

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

Remove a file from the bucket

delete

Permanently deletes a file from the user's storage bucket using its unique fileId.

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Path parameters

fileIdstringRequired

Responses

200

Success

No content

delete

/buckets/{fileId}

HTTPcURLJavaScriptPython

DELETE /v1/buckets/{fileId} HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

No content

Get metadata for a specific file.

get

Retrieves detailed metadata about a single file using its fileId, such as file size, name, upload status, and more.

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Path parameters

fileIdstringRequired

Responses

200

Success

text/plainapplication/jsontext/json

creatorIdstring · nullableOptional

completedbooleanOptional

fileKeystring · nullableOptional

fileNamestring · nullableOptional

totalPartsinteger · int32Optional

originalSizeInBytesinteger · int64Optional

get

/buckets/file/{fileId}

HTTPcURLJavaScriptPython

GET /v1/buckets/file/{fileId} HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "creatorId": "text",
  "completed": true,
  "fileKey": "text",
  "fileName": "text",
  "totalParts": 1,
  "originalSizeInBytes": 1
}

Get a downloadable link for a file.

get

Generates a temporary pre-signed download URL for the specified file.

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Path parameters

fileIdstringRequired

Responses

200

Success

text/plainapplication/jsontext/json

urlstring · nullableOptional

get

/buckets/download/{fileId}

HTTPcURLJavaScriptPython

GET /v1/buckets/download/{fileId} HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "url": "text"
}