BokaMera.API.Host

GetAiChatUsage

The following routes are available for this service:
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.

// @ts-nocheck

export class AiChatUsageResponse
{
    /** @description The company the usage applies to. */
    // @ApiMember(Description="The company the usage applies to.")
    public CompanyId: string;

    /** @description Tokens consumed within the current rolling window. */
    // @ApiMember(Description="Tokens consumed within the current rolling window.")
    public TokensUsed: number;

    /** @description The company's token limit for the window. */
    // @ApiMember(Description="The company's token limit for the window.")
    public TokenLimit: number;

    /** @description Tokens remaining before the limit is reached (never negative). */
    // @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
    public TokensRemaining: number;

    /** @description True while the company is still below its token limit. */
    // @ApiMember(Description="True while the company is still below its token limit.")
    public IsWithinBudget: boolean;

    /** @description Length of the rolling usage window, in days. */
    // @ApiMember(Description="Length of the rolling usage window, in days.")
    public WindowDays: number;

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<AiChatUsageResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class GetAiChatUsage implements ICompany
{
    /** @description The company id. Defaults to the logged-in user's company when omitted. */
    // @ApiMember(DataType="string", Description="The company id. Defaults to the logged-in user's company when omitted.", ParameterType="query")
    public CompanyId?: string;

    public constructor(init?: Partial<GetAiChatUsage>) { (Object as any).assign(this, init); }
}

TypeScript 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

HTTP + JSON

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"}}}