Introduction

The current Quick Sync APIs supports group communication, wallet proof, collaborative messaging, file sharing, chat, and more.

System Operational Status

API is currently under active development and is subject to change. We recommend checking the documentation regularly and subscribing to updates to stay informed about any changes, deprecations, or new features that could impact your implementation.

The APIs are in closed beta, to request access please contact us.

API Version

• Current Version: v1

Base URL:

https://api.quicksync.me/{version}/

Replace {version} with the appropriate API version (e.g., v1).

Authentication

This API uses Bearer Token Authentication. To authenticate, include your token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Some endpoints require a bearer token generated by a wallet ownership verification flow.

This API also uses API Keys to authenticate applications, include your API key in the X-API-KEY header:

X-API-KEY: YOUR_API_KEY

APIs

1. Session API (User Management)

• Create, join, and manage user sessions.

• Control session access with passwords and whitelisting.

2. Upload API (Decentralized File Storage)

• Upload, download, and manage files.

• Supports multipart uploads for large files.

3. Chats API

• Create, retrieve, and manage chat messages.

• Add, view, and track emoji or custom reactions on messages.

• Pin important messages.

4. Wallet Verification API (Blockchain Integration)

• Generate nonce for cryptographic verification.

• Verify wallet ownership from blockchain wallets.

• Used to generate tokens used to access the rest of the APIs

Realtime Events

Quick Sync provides real time features via SignalR Hubs using the WebSocket protocol.

Real time events documentation can be found here.