Quickstart

Buckt gives your users branded S3 buckets on demand. This guide walks you from zero to a bucket with a file in it in under five minutes.

Prerequisites

Install the SDK

pnpm add @buckt/sdk

Authenticate

Every request needs an API key. Pass it as a Bearer token (HTTP) or as the constructor option (SDK).

import { Buckt } from "@buckt/sdk";

const client = new Buckt({ apiKey: process.env.BUCKT_API_KEY });

Create a bucket

Buckets are the top-level container for your files. Each bucket gets a unique ID you'll reference in every file operation.

const bucket = await client.buckets.create({
  name: "my-bucket",
  region: "us-east-1",
});

{
  "id": "bkt_01H8XYZABCDEFGHJKMNPQRSTVW",
  "name": "my-bucket",
  "region": "us-east-1",
  "status": "provisioning",
  "createdAt": "2026-04-24T19:00:00Z"
}

Upload a file

Use the bucket ID from the previous step. The path after /files/ becomes the object key.

import { readFile } from "node:fs/promises";

const buffer = await readFile("logo.png");
await client.files.upload(bucket.id, "images/logo.png", buffer, "image/png");

{
  "key": "images/logo.png",
  "size": 24531,
  "contentType": "image/png",
  "uploadedAt": "2026-04-24T19:01:00Z"
}

List files

const files = await client.files.list(bucket.id);

{
  "data": [
    {
      "key": "images/logo.png",
      "size": 24531,
      "contentType": "image/png",
      "uploadedAt": "2026-04-24T19:01:00Z"
    }
  ],
  "hasMore": false
}

Next steps