| 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. |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class RecordAiChatUsage : ICompany, Codable
{
/**
* 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 var companyId:String?
/**
* 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 var tokensUsed:Int
required public init(){}
}
public class AiChatUsageResponse : Codable
{
/**
* The company the usage applies to.
*/
// @ApiMember(Description="The company the usage applies to.")
public var companyId:String
/**
* Tokens consumed within the current rolling window.
*/
// @ApiMember(Description="Tokens consumed within the current rolling window.")
public var tokensUsed:Int
/**
* The company's token limit for the window.
*/
// @ApiMember(Description="The company's token limit for the window.")
public var tokenLimit:Int
/**
* Tokens remaining before the limit is reached (never negative).
*/
// @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
public var tokensRemaining:Int
/**
* True while the company is still below its token limit.
*/
// @ApiMember(Description="True while the company is still below its token limit.")
public var isWithinBudget:Bool
/**
* Length of the rolling usage window, in days.
*/
// @ApiMember(Description="Length of the rolling usage window, in days.")
public var windowDays:Int
public var responseStatus:ResponseStatus
required public init(){}
}
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
}
}
}