Beezr API

Start with the index

llms.txt lists the pages in navigation order, with descriptions and agent notes. llms-full.txt contains every page's Markdown in one document.

Read one page as Markdown

Every page has an index.md twin and a .md copy. Use the page actions to copy its full Markdown or open it in your assistant. Request and response examples are included. For the overview, use index.md.

Use the machine-readable spec

Download OpenAPI YAML or OpenAPI JSON. Use it with tools that read OpenAPI to inspect the request and response schemas. Writes use v1 paths; reads use v4. Authentication is always X-API-Key on the server.

Add your workspace names

To add your own module and field names, use Brief your AI assistant. It combines the API rules with your names, ready requests, limits and retry rules.

Send dates, numbers and yes/no values in the same form the Designer shows them.