> For the complete documentation index, see [llms.txt](https://docs.quicksync.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.quicksync.me/qs-framework/introduction.md).

# Introduction

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

<a href="https://status.quicksync.me/status/services" class="button secondary">System Operational Status</a>

{% hint style="warning" %}
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.
{% endhint %}

{% hint style="info" %}
The APIs are in closed beta, to request access please contact us.
{% endhint %}

### 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](/qs-framework/wallet-verification-api.md) 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)**](/qs-framework/session-api.md)

* Create, join, and manage user sessions.
* Control session access with passwords and whitelisting.

#### [2. Upload API **(Decentralized File Storage)** ](/qs-framework/upload-api.md)

* Upload, download, and manage files.
* Supports multipart uploads for large files.

#### [3. Chats API](/qs-framework/chats-api.md)

* 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)**](/qs-framework/wallet-verification-api.md)

* 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](/qs-framework/real-time-events.md)

Quick Sync provides real time features via [SignalR ](https://dotnet.microsoft.com/en-us/apps/aspnet/signalr)Hubs using the WebSocket protocol.&#x20;

Real time events documentation can be found [here](/qs-framework/real-time-events.md).&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.quicksync.me/qs-framework/introduction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.