| POST | /assistant/ai-chat/usage | Record AI assistant token usage for a company | Records the tokens consumed by an AI assistant chat turn (input + output) against the company's rolling-window budget and returns the updated usage. 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. |
| TokensUsed | body | integer | Yes | Number of tokens consumed by the chat turn (input + output). |
| 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /assistant/ai-chat/usage HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
TokensUsed: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}