Guide

Quipt API Reference

Comprehensive technical documentation for integrating with Quick Solutions' high-performance backend infrastructure.

Base URL: The API is accessible at https://api.qsmc.live (or http://localhost:8080 in local development).

Authentication

Protected endpoints require the Authorization header containing your issued API token. Pass it with every request as shown below:

HTTP Header

Authorization: qs_tok_9b4e18ac...

Standards

Standard Response Format

All endpoints return standardized JSON payloads wrapped in an ApiResponse container.

Success Response Example (JSON)

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "token": "qs_tok_8f93bc1...",
    "permissions": ["read:files", "write:files"]
  }
}

Account Controller

User Account Registration

Create new studio accounts and dispatch verification emails.

POST /account/register

Public

Registers a new user account. Emails must belong to valid TLDs (.com, .net, .org, .live, .io, .dev, .app). An email verification link is dispatched automatically.

Field	Type	Required	Description
username	String	Required	Desired unique username for the studio account.
password	String	Required	Raw account password (stored securely as SHA-256).
email	String	Required	Unique email address for verification & notifications.

Example Request Body

{
  "username": "quickdev",
  "password": "Secr3tP@ssw0rd!",
  "email": "developer@qsmc.live"
}

GET /account/verify

Public

Validates the pending verification token and activates the account permanently.

Query Parameter	Type	Required	Description
token	String	Required	Raw verification token dispatched via email.
email	String	Required	The matching email address being confirmed.

ANY /account/edit

Requires Auth

Allows permission granting (add_permission) and scoped token generation (create_token).

Token Controller

Token Validation

Verify validity and extract permissions of API tokens.

GET /token/validate

Requires Auth

Validates the token in the Authorization header and returns its active state.

File Controller

File Storage & Assets

Secure multipart file uploads, sanitization, and streaming downloads.

POST /files/upload

Requires Auth

Upload a single multipart file. Sanitizes file names and saves them into the configured storage structure.

POST /files/upload-multiple

Requires Auth

Upload multiple files in batch. Returns detailed status lists of successful and failed files.

GET /files/download/{filePath}

Public / Secure

Downloads a stored file as a stream with path-traversal protection.

Data Controller

Server Management & Uptime

System status, uptime telemetry, and lifecycle maintenance commands.

GET /data/status (or /status)

Public

Returns current JVM server uptime, start time timestamp, and formatted uptime duration.

Response Schema (200 OK)

{
  "success": true,
  "data": {
    "status": "UP",
    "uptime_ms": 142850,
    "uptime_seconds": 142,
    "start_time_ms": 1775105400000,
    "formatted_uptime": "0d 00h 02m 22s"
  }
}

ANY /data/update

Requires Auth

Initiates a graceful server restart and update cycle.

Maintaining and Extending Documentation

This documentation page is structured with modular sections and copy-paste friendly endpoint templates. To add a new endpoint, duplicate any <div class="endpoint-block"> block and add an entry to the sidebar list.