v1.0.0

CryptoPIX Q-Seal API

Integrate quantum-safe file sealing directly into your applications. Our REST API allows you to programmatically encrypt, store, and share files with Zero-Knowledge architecture.

Authentication

The CryptoPIX Q-Seal API uses API keys to authenticate requests. You can view and manage your API keys in theEnterprise Dashboard.

Important: Your API key carries many privileges, so be sure to keep it secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

bash

curl https://api.q-seal.com/v1/seal \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:

Base URL

All API requests should be made to the following base URL:

https://api.q-seal.com/v1

POST

Seal a File

Uploads and encrypts a file. The file is encrypted on the client-side (via SDK) or server-side depending on your integration, then stored in our quantum-safe vault.

Parameters

Field	Type	Description
fileREQ	binary	The file content to be encrypted and stored.
retention_hours	integer	Optional. Hours until file expires. Default: 24.
password_protected	boolean	Optional. Whether to require a password. Default: false.

Example Request

bash

curl https://api.q-seal.com/v1/seal \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -F file=@/path/to/document.pdf \
  -F retention_hours=48

Response

json

{
  "id": "seal_123456789",
  "object": "seal",
  "created": 1678901234,
  "expires_at": 1679074034,
  "url": "https://q-seal.com/seal/a1b2c3d4",
  "status": "active"
}

GET

Retrieve Seal Metadata

Retrieves details about a specific seal, such as expiration time, view count, and status. This does not return the file content.

Example Request

bash

curl https://api.q-seal.com/v1/seal/seal_123456789 \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:

Response

json

{
  "id": "seal_123456789",
  "object": "seal",
  "status": "read_once",
  "views": 1,
  "max_views": 1,
  "downloaded_at": 1678905000
}

Error Codes

Code	Description
400 Bad Request	The request was unacceptable, often due to missing parameters.
401 Unauthorized	No valid API key provided.
404 Not Found	The requested seal does not exist.
410 Gone	The seal has been accessed and burned (self-destructed).