Quick Start
Integrate SyncGate in three steps — copy your API key, send a request, upload a file.
SyncGate exposes a drop-in `/api/s3` gateway compatible with existing S3 client integrations. Follow these three steps to go live.
1. Copy your API key
Sign in to the dashboard, open API Keys, create a key, and copy the secret immediately — it is only shown once.
2. Send a request
Add the `api-key` header to every call. Base URL is your SyncGate host.
3. Upload a file
POST multipart form data with bucket, client (tenant slug), type, and `files` (the upload field name).
bash
curl -X POST "https://syncgate.clairemontferrond.net/api/s3" \
-H "api-key: YOUR_API_KEY" \
-F "bucket=syncgate" \
-F "client=your-tenant-slug" \
-F "type=uploads" \
-F "files=@./document.pdf"
bash
curl -X GET "https://syncgate.clairemontferrond.net/api/s3/syncgate/your-tenant-slug/uploads/document.pdf" \
-H "api-key: YOUR_API_KEY" \
-L -o document.pdf
Tip
Import the Postman collection from the docs sidebar for one-click API testing.