Sporage Storage API
A simple, versioned REST API for files, folders, containers, and metadata — backed by governed, enterprise-grade managed storage.
Base URL
http://localhost:3000/api/v1
All endpoints are versioned under /api/v1. Responses use a consistent JSON envelope with a requestId you can reference in support requests.
Quick start
# 1. Check the API is reachable curl http://localhost:3000/api/v1/health # 2. List your containers curl http://localhost:3000/api/v1/containers \ -H "X-API-Key: sk_live_YOUR_KEY" # 3. Upload a file curl -X POST "http://localhost:3000/api/v1/containers/contracts/files" \ -H "X-API-Key: sk_live_YOUR_KEY" \ -F "file=@agreement.pdf"
Documentation
- Getting started — first request in 5 minutes
- Authentication — API keys and permissions
- Containers — logical storage boundaries
- Files — upload, download, copy, move, delete
- Folders — create and list hierarchies
- Metadata — system and custom metadata
- Errors — stable error codes and handling
- Rate limits — quotas and throttling
- Code examples — curl, JS/TS, Python, C#
- OpenAPI explorer — try the API interactively
- Playground — run every endpoint from your browser