Brief your AI assistant
▾
ChatGPT and Claude write better integration code when they know two things: how the Beezr API works, and the names in your workspace. This page puts both into one brief you paste into the assistant.
How it works
- Copy your names from the Designer. Open your module: the table name is under its name on the module card, and each field's System name is on its Fields page.
- Paste them below. We've filled in an example module, so you can see the brief it makes straight away. Replace it with yours.
- Give the brief to your assistant. Copy it, or open it straight in Claude or ChatGPT, then say what you want built, for example "write a script that sends each new order from our shop into this module".
Never put an API key in the brief. Your code reads the key from your server environment.
Your module
One field per line: the System name, then its type if you know it (priority, INT). Commas, tabs or wide spaces all work.
What the brief contains
- How to call the API: the address, the key header, every endpoint and the response format.
- Your module and fields, with how to send and read each type.
- Ready create, filtered query and update requests that use your names.
- The limits and when to retry.
Check the requests before you run them, and replace sample values with real ones. For the complete documentation in one file, see AI resources.