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. Pass in an identity to assume a specific name and address in the session.

Authorizations

API Key & Wallet Ownership Bearer

X-API-KEYstringRequired

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

AuthorizationstringRequired

Bearer schema token issued by wallet verification.

Body

application/jsontext/jsonapplication/*+json

passwordstring · nullableOptionalDeprecated

whiteListAddressesstring[] · nullableOptionalDeprecated

Responses

200

Success

text/plainapplication/jsontext/json

sessionIdstring · nullableOptional

expiresIninteger · int32Optional

422

Client Error

text/plainapplication/jsontext/json

post

/session

HTTPcURLJavaScriptPython

POST /v1/session HTTP/1.1
Host: api.quicksync.me
X-API-KEY: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "identity": {
    "name": "text",
    "chainAddress": "text"
  },
  "rules": {
    "userCapacity": 1,
    "expiryDurationInSeconds": 1,
    "password": "text",
    "allowOnlyWhitelistedAddresses": true,
    "whiteListAddresses": []
  }
}

application/jsontext/jsonapplication/*+json

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

Join a session

post

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

Authorizations

Wallet Ownershop Bearer

AuthorizationstringRequired

Bearer schema token issued by wallet verification.

Body

application/jsontext/jsonapplication/*+json

sessionIdstring · nullableOptional

passwordstring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

sessionIdstring · nullableOptional

expiresIninteger · int32Optional

401

Unauthorized

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

422

Client Error

text/plainapplication/jsontext/json

post

/session/join

HTTPcURLJavaScriptPython

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"
}

application/jsontext/jsonapplication/*+json

{
  "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

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Responses

200

Success

text/plainapplication/jsontext/json

idstring · nullableOptional

creatorIdstring · nullableOptional

expiryinteger · int32Optional

maxFilesinteger · int32Optional

maxUsersinteger · int32Optional

maxTotalMegaBytesinteger · int64Optional

passwordProtectedbooleanOptional

whiteListAddressesstring[] · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/session/current

HTTPcURLJavaScriptPython

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

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Body

application/jsontext/jsonapplication/*+json

userIdstring · nullableOptional

Responses

200

Success

No content

post

/session/current/kick

HTTPcURLJavaScriptPython

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"
}

application/jsontext/jsonapplication/*+json

200

Success

No content

Disconnect user from session

post

Trigger a disconnect from session

Authorizations

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Responses

200

Success

No content

post

/session/disconnect

HTTPcURLJavaScriptPython

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

Session Bearer

AuthorizationstringRequired

Bearer schema token issued by session credentials

Responses

200

Session deleted successfully.

No content

delete

/session/current

HTTPcURLJavaScriptPython

DELETE /v1/session/current HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Session deleted successfully.

No content