| GET | /assistant/ai-chat/usage | Get the AI assistant token usage and limit for a company | Returns how many AI assistant tokens the company has consumed in the current rolling window, the configured limit and whether the company is still within budget. Defaults to the logged-in user's company when no CompanyId is supplied. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | string | No | The company id. Defaults to the logged-in user's company when omitted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | The company the usage applies to. |
| TokensUsed | form | long | No | Tokens consumed within the current rolling window. |
| TokenLimit | form | int | No | The company's token limit for the window. |
| TokensRemaining | form | long | No | Tokens remaining before the limit is reached (never negative). |
| IsWithinBudget | form | bool | No | True while the company is still below its token limit. |
| WindowDays | form | int | No | Length of the rolling usage window, in days. |
| ResponseStatus | form | ResponseStatus | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /assistant/ai-chat/usage HTTP/1.1 Host: api.bookmore.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"TokensUsed":0,"TokenLimit":0,"TokensRemaining":0,"IsWithinBudget":false,"WindowDays":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}