| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class GetAiChatUsage : ICompany
{
/**
* 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")
override var CompanyId:UUID? = null
}
open class AiChatUsageResponse
{
/**
* The company the usage applies to.
*/
@ApiMember(Description="The company the usage applies to.")
open var CompanyId:UUID? = null
/**
* Tokens consumed within the current rolling window.
*/
@ApiMember(Description="Tokens consumed within the current rolling window.")
open var TokensUsed:Long? = null
/**
* The company's token limit for the window.
*/
@ApiMember(Description="The company's token limit for the window.")
open var TokenLimit:Int? = null
/**
* Tokens remaining before the limit is reached (never negative).
*/
@ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
open var TokensRemaining:Long? = null
/**
* True while the company is still below its token limit.
*/
@ApiMember(Description="True while the company is still below its token limit.")
open var IsWithinBudget:Boolean? = null
/**
* Length of the rolling usage window, in days.
*/
@ApiMember(Description="Length of the rolling usage window, in days.")
open var WindowDays:Int? = null
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: testapi.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}