Developer API

Session API

API for creating, joining, and managing user sessions.

Session API provides a set of endpoints for group management

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.

Create a session

post

Creates a new session with the specified parameters. Requires Authorization header with bearer token generated from wallet proof.

Authorizations
Body
whiteListAddressesstring[] | nullableOptional
passwordstring | nullableOptional
Responses
200
Success
post
POST /v1/session HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "whiteListAddresses": [
    "text"
  ],
  "password": "text"
}
{
  "sessionId": "text",
  "expiresIn": 1,
  "credentials": {
    "token": "text",
    "id": "text",
    "pseudonym": "text",
    "role": "text"
  },
  "rules": {
    "maxFiles": 1,
    "maxUsers": 1,
    "maxTotalMegaBytes": 1,
    "passwordProtected": true,
    "whiteListAddresses": [
      "text"
    ]
  }
}

Join a session

post

Allows a user to join an existing session. Requires Authorization header with bearer token generated from wallet proof.

Authorizations
Body
sessionIdstring | nullableOptional
passwordstring | nullableOptional
Responses
200
Success
post
POST /v1/session/join HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "sessionId": "text",
  "password": "text"
}
{
  "sessionId": "text",
  "expiresIn": 1,
  "credentials": {
    "token": "text",
    "id": "text",
    "pseudonym": "text",
    "role": "text"
  },
  "rules": {
    "maxFiles": 1,
    "maxUsers": 1,
    "maxTotalMegaBytes": 1,
    "passwordProtected": true,
    "whiteListAddresses": [
      "text"
    ]
  },
  "users": [
    {
      "id": "text",
      "role": "text",
      "name": "text",
      "address": "text"
    }
  ]
}

Get the current session

get

Retrieves the current session for the authenticated user.

Authorizations
Responses
200
Success
get
GET /v1/session/current HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "creatorId": "text",
  "expiry": 1,
  "maxFiles": 1,
  "maxUsers": 1,
  "users": [
    {
      "id": "text",
      "role": "text",
      "name": "text",
      "address": "text"
    }
  ],
  "maxTotalMegaBytes": 1,
  "passwordProtected": true,
  "whiteListAddresses": [
    "text"
  ]
}

Kick user from session

post

Kick a user from the current session

Authorizations
Body
userIdstring | nullableOptional
Responses
200
Success
post
POST /v1/session/current/kick HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "userId": "text"
}
200

Success

No content

Disconnect user from session

post

Trigger a disconnect from session

Authorizations
Responses
200
Success
post
POST /v1/session/disconnect HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

No content

Delete the current session

delete

Deletes the session of the authenticated user with host role.

Authorizations
Responses
200
Session deleted successfully.
delete
DELETE /v1/session/current HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Session deleted successfully.

No content
PreviousIntroductionNextUpload API

Last updated