Loading...
One Big File
Fast, private file tools.
Loading...
API docs
Use Authorization: Bearer at_test_... or at_live_... for every API request. Responses use stable { ok, data, meta } and { ok, error, meta } envelopes.
Note: remove-background and qr-code-generator still work through this API even though their web pages now live at bg.onebigfile.com and qr.onebigfile.com — only the on-site UI moved, the processing endpoints didn’t.
curl -X POST https://onebigfile.com/api/v1/jobs \
-H "Authorization: Bearer at_test_prefix_secret" \
-F "toolSlug=compress-image" \
-F "settings={\"mode\":\"recommended\"}" \
-F "files=@photo.jpg"| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/account | Get account API entitlements |
| GET | /api/v1/tools | List tools |
| GET | /api/v1/tools/{toolSlug} | Get one tool |
| GET/POST | /api/v1/jobs | List jobs / Create processing job |
| GET | /api/v1/jobs/{jobId} | Get job |
| POST | /api/v1/jobs/{jobId}/cancel | Cancel job |
| GET | /api/v1/jobs/{jobId}/download | Get protected download URLs |
| GET | /api/v1/files/uploads | Get upload policy |
| GET | /api/v1/usage | Get usage summary |
| GET/POST | /api/v1/webhooks | List webhook endpoints / Create webhook endpoint |
| GET/PATCH/DELETE | /api/v1/webhooks/{webhookId} | Get webhook endpoint / Update webhook endpoint / Delete webhook endpoint |