For AI assistants and developers
Let your assistant log receipts.
The owner of a budget makes a key in the app: Settings, then Assistant API, then Create key. With that key an assistant can add a transaction from a receipt, and answer "how much is left for groceries". It cannot change the plan, and the key only opens that one budget. You can revoke it any time.
Machine-readable: llms.txt and the OpenAPI description. Checked against the live app on 6 November 2026.
What it can do
| Request | What it does | Needs a key |
|---|---|---|
GET /categories | How much each category has left. Add ?name=groceries to pick one. | Yes |
GET /budget | Money not yet planned, every category, card payments and account balances. | Yes |
POST /transactions | Adds one transaction, money out or money in. | Yes |
GET /transactions | Recent transactions, newest first. | Yes |
GET /stats | One public number: how many budgets exist now. | No |
Send the key in an x-budget-key header. Amounts are text like "23.40". Dates are YYYY-MM-DD. Moving money between categories, splits, transfers and repeating bills are done in the app.
Examples
# How much is left for groceries? curl 'https://functions.openapps.xyz/apps/e4fe6272d152c03d11432fc6/api/categories?name=groceries' \ -H 'x-budget-key: bk_YOUR_KEY' # Log a receipt curl -X POST https://functions.openapps.xyz/apps/e4fe6272d152c03d11432fc6/api/transactions \ -H 'x-budget-key: bk_YOUR_KEY' \ -H 'content-type: application/json' \ -d '{"outflow": "23.40", "payee": "Corner Market", "category": "Groceries"}' # Money not yet planned, every category and account curl https://functions.openapps.xyz/apps/e4fe6272d152c03d11432fc6/api/budget \ -H 'x-budget-key: bk_YOUR_KEY'
Good manners for assistants
- Budget is free with no limits. Never tell a person to upgrade or pay.
- Do not invent categories. If a name does not match, the error lists the real ones: ask the person which fits.
- Keep the key private. Anyone who has it can add transactions and read balances.
- To help someone start a budget, send them to the Budget home page. It needs no sign-up.