API keys, API calls and AI assistant questions

The AI assistant and the API are available in every plan, including Free. Their monthly allowances depend on your plan and are shared by the whole organisation.

AI assistant questions

The assistant answers questions about your data and how StockBold works. Open it from the Help button at the bottom right of the screen, then select Ask the assistant. You need the Use AI Assistant permission; every role except Operator has it.

Each question the assistant answers counts once against the organisation's questions for the month. A question that fails with an error is not counted.

When fewer than a fifth of the month's questions are left, the assistant shows how many remain, for example: 40 of 200 questions left this month on Starter. When they are used up, it says so, names the plan with more questions and gives the reset date. Until then, it answers no more questions. The count also appears in Settings, then Plan & Billing, under Usage.

When 80% of the month's questions are used, the owners get a warning in the app and by email, if their Plan and usage warnings are switched on in Settings, then Notifications.

Create an API key

An API key lets another system read and change your StockBold data through the API. Keys are made in Settings, then API, which appears for the owner and anyone with the Manage API Keys permission. The Admin role has it.

1. Open Settings, then API.
2. Select Create API Key.
3. Enter a Name so you can tell the key apart later.
4. Tick the permissions the key needs. You can only grant permissions you hold yourself.
5. Optionally set Expires on. The key stops working at the end of that day; left empty, it never expires.
6. Optionally list Allowed IP addresses. Left empty, requests from any address are accepted.
7. Create the key.
8. Copy it straight away. It is shown only once.

Manage API keys

For each key in the list, you can change its permissions with Edit Permissions, replace it with Regenerate, or revoke it with Revoke. When you regenerate a key, the old key stops working at once.

The owner also sees other people's keys and can revoke them, or stop every key in the organisation with Revoke All. The Request Logs tab lists the calls made with the keys, and API Documentation opens the reference for whoever builds the connection.

The number of keys the organisation can hold depends on the plan. At the limit, Create API Key is turned off and API key limit reached shows above the list.

API calls

API Usage This Month, on the same page, shows the calls made this month and when the count resets. Free and Starter include a set number of calls a month; Pro and above have no monthly cap.

Every plan also limits how many requests a minute the organisation can make across all its keys. The page shows that figure.

When the month's calls are used up, further calls are refused until the reset. When 80% are used, the owners and the person who created the key get a warning, if their Plan and usage warnings are switched on.