1. BWEZE Domains
  2. Agents

Built for your agents.

Everything BWEZE does works from a terminal or one REST API, with errors and docs an agent can read as well as you.

CLI
npx @bweze/cli login
API spec
openapi.json
Docs index
llms.txt

One CLI

Agents drive BWEZE from the terminal the same way people do:

npx @bweze/cli login
bweze projects create acme-web --type frontend
bweze projects domains search acme

One REST API

Anything the CLI does is also a plain REST call with a bearer key, described by an OpenAPI spec atapi.bweze.com/v1/openapi.json. Give an agent a token limited to the actions, projects and IP range it needs, and only for as long as it needs it.

Errors an agent can branch on

Every error, everywhere, has the same shape. Branch on code; the message is for people.

{ "error": { "code": "insufficient_balance", "message": "...", "docs": "https://docs.bweze.com/errors/insufficient_balance" } }
CodeStatusWhat to do
insufficient_balance402Top up before retrying
recipient_opted_out409Never retry
idempotency_key_reuse_mismatch409Same key, different content
message_too_long400Over 10 segments
token_permission_denied403The token was not granted this action

Retries that never double-act

Calls that spend money or send a message accept an idempotency key. A retry with the same key returns the first result instead of acting again, so an agent that loses a response can simply try again.

Docs written for machines too

  • llms.txt indexes the docs on one screen, andllms-full.txt puts everything an agent needs in one file.
  • Every docs page is also served as raw Markdown, for tools that want one page of context.
  • This site has its own llms.txt, and every guide, post and comparison has a Markdown copy at the same address ending in .md.

The messaging SDK

import { BwezeMessaging } from "@bweze/messaging";

const sms = new BwezeMessaging({ apiKey: process.env.BWEZE_API_KEY! });
await sms.send({ to: "+250788123456", template: "Code {{c}}", data: { c: 1234 } });

Its errors throw a typed BwezeError with the same code and docs link as the API.

Hand it to your agent.

Read the docs