| GET | /assistant/mcp/usage | Get the public MCP server token usage and limit for a company | Returns how many tokens the company has consumed in the current rolling window through the public MCP server it connects to external AI clients, the configured limit and whether the company is still within budget. Metered separately from the admin AI assistant. 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 GetMcpUsage : 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?
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /assistant/mcp/usage HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}