Operations

Quickstart

1. Sign up for a 30-day trial

Start your free trial with your work email. You’ll receive a trial license key and install instructions. Layer runs in your AWS account, in front of your existing Turbopuffer store.

2. Install in your AWS account

Have Go, the AWS CLI, Terraform, Helm, and kubectl installed, with AWS credentials configured. Set your Turbopuffer API key and the trial license key from your email, then run the installer:

git clone https://github.com/hev/layer.git
cd layer
go build -o layer ./apps/layer-cli
export TURBOPUFFER_API_KEY="tpuf_..."
export LICENSE_TOKEN="your-trial-license-key"
./layer install

Review and confirm the plan. The installer provisions the AWS infrastructure and installs Layer in your cluster. The install guide covers prerequisites, configuration, and existing infrastructure.

3. Switch your client

Point your client at your new gateway endpoint and keep your Turbopuffer API key. Your data stays in Turbopuffer; requests now go through Layer.

export LAYER_GATEWAY_URL="https://your-layer-gateway"
export LAYER_GATEWAY_API_KEY="$TURBOPUFFER_API_KEY"

Layer’s Python, Go, and TypeScript clients expose the gateway’s additional operations:

import os
from hevlayer import AsyncHevlayer

client = AsyncHevlayer(
    base_url=os.environ["LAYER_GATEWAY_URL"],
    api_key=os.environ["LAYER_GATEWAY_API_KEY"],
)
import (
    "os"
    hevlayer "github.com/hev/layer-go"
)

client := hevlayer.NewClient(
    hevlayer.WithBaseURL(os.Getenv("LAYER_GATEWAY_URL")),
    hevlayer.WithAPIKey(os.Getenv("LAYER_GATEWAY_API_KEY")),
)
import { Hevlayer } from "hevlayer";

const client = new Hevlayer({
  baseUrl: process.env.LAYER_GATEWAY_URL,
  apiKey: process.env.LAYER_GATEWAY_API_KEY,
});
curl --fail-with-body "$LAYER_GATEWAY_URL/v2/namespaces" \
  -H "Authorization: Bearer $LAYER_GATEWAY_API_KEY"

Explore the API docs or see Layer in action in the demos.

esc