Skip to main content
Flux is a secure, encrypted file platform built for privacy-first storage and delivery. These docs cover the internal services, API endpoints, and architecture that power Flux.
These docs are intended for internal developers only. All services run on the internal network and are not accessible from the public internet. If you’re looking for the user-facing product, visit fluxdrop.eu.

​
Platform services

Flux is composed of modular services, each responsible for a specific domain:

Metadata Service

Manages file metadata, DEK wrapping, caching with Valkey, and aggregate statistics.

Thumbnail Service

Generates and serves responsive thumbnails for uploaded files. Coming soon.

Flux Pass

Handles authentication, sessions, and access control.

​
Key concepts

Before diving into the API, familiarize yourself with these core concepts:
ConceptDescription
DEKData Encryption Key - a per-file symmetric key used to encrypt file contents.
Master keyServer-side key used to wrap (encrypt) and unwrap (decrypt) DEKs.
ValkeyIn-memory cache layer used to store frequently accessed metadata with TTL-based expiration.
ConvexThe primary database backing persistent metadata and file records.

​
API conventions

All Flux API endpoints follow a consistent pattern: 
/api/{version}/{resource}
  • Current version: v1
  • No hyphens in endpoint paths
  • Standard methods: POST, GET, DELETE
Read the full API conventions guide for details.

​
Get started

Quickstart

Set up your environment and make your first API call in minutes.