| 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. |
|---|
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 GetAiChatUsage(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.
"""
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.
GET /assistant/ai-chat/usage HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
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
}
}
}