Set usage limits for a client
Optional caps stop one client consuming everything. When a cap is reached, that client's requests are blocked until the next period.
Usage limits are optional caps on a single client. They exist so one client cannot consume the capacity your other clients depend on.
One of the three caps blocks. Reaching API calls per day stops that client’s requests until midnight UTC, and nothing has to be reset by hand.
The other two are counted and shown against the number you set, and do not block anything.
Your organisation’s own limits still apply on top. A client cap can only make a client’s allowance smaller, never larger.
Before you begin
Look at what the client actually uses before choosing a number. A cap set below normal usage blocks legitimate work.
Decide which caps you want. Any of them can be left blank for unlimited, and only the daily API cap changes what a client can do.
Set the limits
- Open the client and find the Usage limits card.
- Turn on Enable usage limits. The three fields appear.
- Set API calls per day to cap what the client can actually use. Conversations per month and Actions per day are recorded against your figure without blocking anything.
- Select Save limits.
The card keeps the values after a reload once it has saved.
Good to know
Leaving the toggle off means the client has no individual caps at all, which is the default.
The same card also carries an option to raise how much context a single conversation may use for this client only. That is off by default and is for clients running unusually long investigations, not for capacity control.
Verify it worked
Reload the client and confirm the values are still there.
Check the usage figures for that client after a day and confirm they are being counted against the figures you set.
If something doesn’t look right
If requests are blocked sooner than expected, check your organisation’s own limits as well. The tighter of the two applies, and only the daily API cap blocks at the client level.
If a value did not save, confirm you selected Save limits on that card rather than a save button elsewhere on the page.
If a client is over limit and needs more today, raising the cap takes effect for that client, though your organisation’s limit still applies.
If none of that explains it, open a support conversation from the Help drawer. Include the client name and the caps you set.
FAQ
Q: What happens when a limit is reached?
A: Reaching the daily API cap blocks that client’s requests until midnight UTC. Passing either of the other two figures is shown but does not block.
Q: Do limits apply to my own organisation?
A: These caps are per client. Your organisation’s limits are separate and always apply.
Q: Can I leave some unlimited?
A: Yes. Leave a field blank and that particular cap is unlimited.