| 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. |
|---|
"use strict";
export class AiChatUsageResponse {
/** @param {{CompanyId?:string,TokensUsed?:number,TokenLimit?:number,TokensRemaining?:number,IsWithinBudget?:boolean,WindowDays?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company the usage applies to. */
CompanyId;
/**
* @type {number}
* @description Tokens consumed within the current rolling window. */
TokensUsed;
/**
* @type {number}
* @description The company's token limit for the window. */
TokenLimit;
/**
* @type {number}
* @description Tokens remaining before the limit is reached (never negative). */
TokensRemaining;
/**
* @type {boolean}
* @description True while the company is still below its token limit. */
IsWithinBudget;
/**
* @type {number}
* @description Length of the rolling usage window, in days. */
WindowDays;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class RecordAiChatUsage {
/** @param {{CompanyId?:string,TokensUsed?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id. Defaults to the logged-in user's company when omitted. */
CompanyId;
/**
* @type {number}
* @description Number of tokens consumed by the chat turn (input + output). */
TokensUsed;
}
JavaScript RecordAiChatUsage DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","TokensUsed":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}