| 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. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class AiChatUsageResponse implements JsonSerializable
{
public function __construct(
/** @description The company the usage applies to. */
// @ApiMember(Description="The company the usage applies to.")
/** @var string */
public string $CompanyId='',
/** @description Tokens consumed within the current rolling window. */
// @ApiMember(Description="Tokens consumed within the current rolling window.")
/** @var int */
public int $TokensUsed=0,
/** @description The company's token limit for the window. */
// @ApiMember(Description="The company's token limit for the window.")
/** @var int */
public int $TokenLimit=0,
/** @description Tokens remaining before the limit is reached (never negative). */
// @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
/** @var int */
public int $TokensRemaining=0,
/** @description True while the company is still below its token limit. */
// @ApiMember(Description="True while the company is still below its token limit.")
/** @var bool|null */
public ?bool $IsWithinBudget=null,
/** @description Length of the rolling usage window, in days. */
// @ApiMember(Description="Length of the rolling usage window, in days.")
/** @var int */
public int $WindowDays=0,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['TokensUsed'])) $this->TokensUsed = $o['TokensUsed'];
if (isset($o['TokenLimit'])) $this->TokenLimit = $o['TokenLimit'];
if (isset($o['TokensRemaining'])) $this->TokensRemaining = $o['TokensRemaining'];
if (isset($o['IsWithinBudget'])) $this->IsWithinBudget = $o['IsWithinBudget'];
if (isset($o['WindowDays'])) $this->WindowDays = $o['WindowDays'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->TokensUsed)) $o['TokensUsed'] = $this->TokensUsed;
if (isset($this->TokenLimit)) $o['TokenLimit'] = $this->TokenLimit;
if (isset($this->TokensRemaining)) $o['TokensRemaining'] = $this->TokensRemaining;
if (isset($this->IsWithinBudget)) $o['IsWithinBudget'] = $this->IsWithinBudget;
if (isset($this->WindowDays)) $o['WindowDays'] = $this->WindowDays;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class RecordAiChatUsage implements ICompany, JsonSerializable
{
public function __construct(
/** @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")
/** @var string|null */
public ?string $CompanyId=null,
/** @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)
/** @var int */
public int $TokensUsed=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['TokensUsed'])) $this->TokensUsed = $o['TokensUsed'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->TokensUsed)) $o['TokensUsed'] = $this->TokensUsed;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<RecordAiChatUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<TokensUsed>0</TokensUsed>
</RecordAiChatUsage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AiChatUsageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<IsWithinBudget>false</IsWithinBudget>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<TokenLimit>0</TokenLimit>
<TokensRemaining>0</TokensRemaining>
<TokensUsed>0</TokensUsed>
<WindowDays>0</WindowDays>
</AiChatUsageResponse>