BokaMera.API.Host

RecordAiChatUsage

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

// @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 RecordAiChatUsage 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;

    /** @description Number of tokens consumed by the chat turn (input + output). */
    // @ApiMember(DataType="integer", Description="Number of tokens consumed by the chat turn (input + output).", IsRequired=true)
    public TokensUsed: number;

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

TypeScript RecordAiChatUsage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}