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.
Creates a new session with the specified parameters. Pass in an identity to assume a specific name and address in the session.
Bearer schema token issued by wallet verification.
API key issued for beta developers for creating/joining sessions.
Success
Client Error
POST /v1/session HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 184
{
"identity": {
"name": "text",
"chainAddress": "text"
},
"rules": {
"userCapacity": 1,
"expiryDurationInSeconds": 1,
"password": "text",
"allowOnlyWhitelistedAddresses": true,
"whiteListAddresses": []
}
}{
"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": []
}
}Allows a user to join an existing session. Requires Authorization header with bearer token generated from wallet proof.
Bearer schema token issued by wallet verification.
Success
Unauthorized
Not Found
Client Error
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"
}
]
}Retrieves the current session for the authenticated user.
Bearer schema token issued by session credentials
Success
Not Found
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 a user from the current session
Bearer schema token issued by session credentials
Success
No content
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"
}Success
No content
Trigger a disconnect from session
Bearer schema token issued by session credentials
Success
No content
POST /v1/session/disconnect HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Success
No content
Deletes the session of the authenticated user with host role.
Bearer schema token issued by session credentials
Session deleted successfully.
No content
DELETE /v1/session/current HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Session deleted successfully.
No content
Last updated