Files

Documentation

Everything you need to store and serve files from your application.

Quickstart

Create a token in your account settings, install an SDK and upload your first object.

npm install @files/sdk
# or
pip install files-sdk

Authentication

All requests carry a bearer token in the Authorization header. Tokens are scoped to a bucket and can be limited to read-only access.

curl -H "Authorization: Bearer $FILES_TOKEN" \
  https://files.exheavy.site/v1/objects?prefix=reports/

Endpoints

MethodPathDescription
PUT/v1/objects/{key}Upload or overwrite an object
GET/v1/objects/{key}Download an object
GET/v1/objectsList objects by prefix
HEAD/v1/objects/{key}Read metadata only
POST/v1/signed-urlsCreate a time-limited link

SDKs

The JavaScript and Python libraries wrap the API with automatic retries, resumable uploads and typed responses.

from files_sdk import Files

files = Files(token=os.environ["FILES_TOKEN"])
files.put("backups/db.sql.gz", open("db.sql.gz", "rb"))
for obj in files.list(prefix="backups/"):
    print(obj.key, obj.size)

Limits