API docs

Public API v1

Use Authorization: Bearer at_test_... or at_live_... for every API request. Responses use stable { ok, data, meta } and { ok, error, meta } envelopes.

Create a job

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"

Endpoints

Method	Path	Purpose
GET	/api/v1/account	Inspect account and API entitlement state.
GET	/api/v1/tools	List available processing tools.
GET	/api/v1/tools/{toolSlug}	Inspect one tool's accepted files and limits.
POST	/api/v1/jobs	Create a multipart async processing job.
GET	/api/v1/jobs	List jobs created by the current API key.
GET	/api/v1/jobs/{jobId}	Read progress and output metadata.
POST	/api/v1/jobs/{jobId}/cancel	Cancel an active job.
GET	/api/v1/jobs/{jobId}/download	Return temporary protected download URLs.
GET	/api/v1/usage	Summarize metered API usage.
GET/POST	/api/v1/webhooks	List and create webhook endpoints.

OpenAPI

Download the machine-readable v1 contract.

Dashboard

Create and revoke keys from your account.

Changelog

Track public API changes.