Brault Developers

Changelog

What shipped in each version of the Brault public API.

Per Conventions § Versioning, additive changes — new fields, new endpoints, new optional parameters, new enum values — never appear here as a breaking change and never bump the path version. A genuinely breaking change will get its own dated entry and ship as /v2 alongside /v1.

2026-09-09 — Central and regional hosts

Additive, no version bump. Nothing you have built stops working, and no key needs re-minting.

/v1 now names two hosts instead of one. api.brault.app is the central host and serves 7 paths — /v1/me, /v1/usage, /v1/events, /v1/brandspace, /v1/members, /v1/members/{user_id} and /v1/roles. Everything else is regional and belongs on https://<region>.api.brault.app, which is https://us.api.brault.app today. The reason is data residency: content is answered by a machine in the brandspace's own region. See Central and regional hosts.

  • Your key now prints its host. New keys read bsk_us_…; the segment after bsk_ is the regional host to dial. A key minted before this has no such segment, means us, and keeps working forever — there is no sunset and no re-mint.
  • GET /v1/me answers the question directly. It gained hosts.central, hosts.regional, brandspace.region, key.region and key.region_stale. The brandspace's region is authoritative; the one printed in the key is a hint.
  • Calling the central host for a regional path still works today. It will start carrying Deprecation: true, a Sunset date and a Link header pointing at the Conventions page. The Sunset date is not yet set; it will be announced here, in its own entry, before any header carries it.
  • A new error code, 421 misdirected_request. It cannot occur today — there is one region — and appears only when a host's region is not the brandspace's. details.host names the host that will answer.
  • Every example on this site is now labeled Central or Regional and shows the host it calls, and the API reference marks each operation's plane.

Also now documented, both already live: POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver and POST /v1/webhooks/{webhook_id}/replays — see the Webhooks reference.

2026-09-07 — Transfers

Additive, no version bump (see Conventions § Versioning).

  • TransfersPOST /v1/transfers packages Brault files and folders, files you upload, or both, into one expiring public link. Uploads follow the same single-PUT and multipart flow as /v1/uploads, and POST /v1/transfers/:id/complete finalizes the package. List, read, update the expiry or password, and expire one early. See Send a transfer and the Transfers reference.
  • Two new scopestransfers:read and transfers:write. Existing keys do not get them automatically: edit the key in Settings → Developers and tick the Transfers row.
  • Four new webhook eventstransfer.created, transfer.ready, transfer.downloaded and transfer.expired, bringing the catalogue to 58. A key subscribed with ["*"] already receives them.

v1.0.0 — 2026-09-06

Initial public release of /v1.

  • Content — libraries, folders, files, versions, uploads (single-PUT and multipart), downloads, keyword and natural-language search, importing a file from a public URL. Read-only brandspace, member and role lookups.
  • Boards — boards, board properties and options, brandspace-wide properties and options, setting and reading property values on files, filtering GET /v1/files and querying a board with the JSON filter grammar.
  • Review, pages and shares — comments and replies (with a CSV export), pages (create, read as JSON or Markdown, append blocks, publish/unpublish), and shared links (create, read, update, delete).
  • Webhooks — endpoints, deliveries, the event catalogue (GET /v1/events), signed payloads, and the Settings → Developers → Webhooks panel.
  • Platform — API keys with per-area scopes, per-brandspace rate limits and monthly quotas, cursor pagination, a uniform error envelope, and Idempotency-Key support on every POST.

See Getting Started for the base URL and your first request, or jump straight to the API Reference for every operation.

On this page