Getting started

Bounded, revocable spend limits for your agents and automated systems.

1. Sign in to the Console

Open the Console and sign in with GitHub, or with a sign-in link sent to your email address.

2. Create a tenant

On the Tenants page, name a tenant in a free or unused slot’s row and create it. “Purchase more tenants” leads to the slots you can buy, with their prices and what each one includes.

The Console then shows the tenant’s admin key, once. Keep it somewhere safe: your code sends it as a Bearer token on every call. The Console also shows the tenant’s address, the URL your code calls.

Setting up with a coding agent

An agent can do the same without a person copying a key by hand. Give it this one sentence:

Read https://console-api.buckette.co/docs/llm.md and set me up on buckette.

The agent then follows the control plane’s guide, in this order:

  1. Ask for approval. It calls POST https://console-api.buckette.co/auth/device/start and gets a short code (XXXX-XXXX) and a link. It shows you both.
  2. Approve in the browser. You open the link, which is a page of the Console, sign in (an account is created if you have none), check the label the agent gave itself and approve the code. Only approve a code your own agent just showed you.
  3. The agent receives an account key (cpk_..., valid 90 days) and creates a tenant for you with POST /tenants. The answer carries the tenant’s address and its admin key (bk_...), shown once.
  4. The tenant’s own guide takes over. With that key and address, the agent reads GET /docs/llm.md on the tenant’s address, the guide described in the next section, and works with buckets from there.

The control plane’s guide also describes the other route, where you create a key in the Console’s Account tab and hand it to the agent yourself. Its OpenAPI description is at console-api.buckette.co/openapi.json.

3. Read the documentation the service serves

Every buckette instance documents itself, and that documentation is the reference: it describes the routes, the authentication and the scopes of the version that is running.

  • GET /help: the list of topics, then GET /help/<topic> for each one (buckets, consuming, replenishment, reservations, webhooks, and more).
  • GET /openapi.json: every route and payload, as an OpenAPI description.
  • GET /docs/llm.md: a longer guide, written for an LLM agent that integrates buckette. It assumes the agent already has a tenant’s key and address (steps 1 and 2 above, or the agent path above); it covers the tenant’s API only.

These links go to the instance buckette runs today, euw1-tpm52cdn-tomme.api.buckette.co. The same paths work on your tenant’s own address, the one the Console shows, and that is the address your code should call. None of the three needs a key:

curl https://euw1-tpm52cdn-tomme.api.buckette.co/help