BokaMera.API.Host

<back to all web services

RecordAiChatUsage

Requires Authentication
The following routes are available for this service:
POST/assistant/ai-chat/usageRecord AI assistant token usage for a companyRecords 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.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AiChatUsageResponse
    {
        ///<summary>
        ///The company the usage applies to.
        ///</summary>
        [ApiMember(Description="The company the usage applies to.")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///Tokens consumed within the current rolling window.
        ///</summary>
        [ApiMember(Description="Tokens consumed within the current rolling window.")]
        public virtual long TokensUsed { get; set; }

        ///<summary>
        ///The company's token limit for the window.
        ///</summary>
        [ApiMember(Description="The company's token limit for the window.")]
        public virtual int TokenLimit { get; set; }

        ///<summary>
        ///Tokens remaining before the limit is reached (never negative).
        ///</summary>
        [ApiMember(Description="Tokens remaining before the limit is reached (never negative).")]
        public virtual long TokensRemaining { get; set; }

        ///<summary>
        ///True while the company is still below its token limit.
        ///</summary>
        [ApiMember(Description="True while the company is still below its token limit.")]
        public virtual bool IsWithinBudget { get; set; }

        ///<summary>
        ///Length of the rolling usage window, in days.
        ///</summary>
        [ApiMember(Description="Length of the rolling usage window, in days.")]
        public virtual int WindowDays { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class RecordAiChatUsage
        : ICompany
    {
        ///<summary>
        ///The company id. Defaults to the logged-in user's company when omitted.
        ///</summary>
        [ApiMember(DataType="string", Description="The company id. Defaults to the logged-in user's company when omitted.", ParameterType="query")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Number of tokens consumed by the chat turn (input + output).
        ///</summary>
        [ApiMember(DataType="integer", Description="Number of tokens consumed by the chat turn (input + output).", IsRequired=true)]
        public virtual long TokensUsed { get; set; }
    }

}

C# RecordAiChatUsage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","TokensUsed":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}