| 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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AiChatUsageResponse:
# @ApiMember(Description="The company the usage applies to.")
company_id: Optional[str] = None
"""
The company the usage applies to.
"""
# @ApiMember(Description="Tokens consumed within the current rolling window.")
tokens_used: int = 0
"""
Tokens consumed within the current rolling window.
"""
# @ApiMember(Description="The company's token limit for the window.")
token_limit: int = 0
"""
The company's token limit for the window.
"""
# @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
tokens_remaining: int = 0
"""
Tokens remaining before the limit is reached (never negative).
"""
# @ApiMember(Description="True while the company is still below its token limit.")
is_within_budget: bool = False
"""
True while the company is still below its token limit.
"""
# @ApiMember(Description="Length of the rolling usage window, in days.")
window_days: int = 0
"""
Length of the rolling usage window, in days.
"""
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordAiChatUsage(ICompany):
# @ApiMember(DataType="string", Description="The company id. Defaults to the logged-in user's company when omitted.", ParameterType="query")
company_id: Optional[str] = None
"""
The company id. Defaults to the logged-in user's company when omitted.
"""
# @ApiMember(DataType="integer", Description="Number of tokens consumed by the chat turn (input + output).", IsRequired=true)
tokens_used: int = 0
"""
Number of tokens consumed by the chat turn (input + output).
"""
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>