| 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. |
|---|
"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 GetAiChatUsage {
/** @param {{CompanyId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id. Defaults to the logged-in user's company when omitted. */
CompanyId;
}
JavaScript GetAiChatUsage DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}