XaitCPQ API

POST ai/token

Adds a token usage entry. Any user that's logged in can add a token usage entry for themselves.

Request Information

URI

https://ofd-api.blueprintcpq.net/ai/token

URI Parameters

None.

Body Parameters

The token usage entry to add.

UpdateTokenUsage
NameDescriptionTypeAdditional information
Id

string

None.
ConversationId

string

None.
UserId

string

None.
QuoteId

string

None.
Timestamp

date

None.
Operation

string

None.
Provider

string

None.
Workflow

string

None.
RequestModel

string

None.
ResponseModel

string

None.
ServerAddress

string

None.
Port

integer

None.
ErrorType

string

None.
InputTokens

integer

None.
OutputTokens

integer

None.
ReasoningTokens

integer

None.
CustomerProvidedAccount

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "ConversationId": "sample string 2",
  "UserId": "sample string 3",
  "QuoteId": "sample string 4",
  "Timestamp": "2026-10-02T23:36:54.1918554Z",
  "Operation": "sample string 6",
  "Provider": "sample string 7",
  "Workflow": "sample string 8",
  "RequestModel": "sample string 9",
  "ResponseModel": "sample string 10",
  "ServerAddress": "sample string 11",
  "Port": 1,
  "ErrorType": "sample string 12",
  "InputTokens": 13,
  "OutputTokens": 14,
  "ReasoningTokens": 15,
  "CustomerProvidedAccount": true
}

text/html

Sample: 
{"Id":"sample string 1","ConversationId":"sample string 2","UserId":"sample string 3","QuoteId":"sample string 4","Timestamp":"2026-10-02T23:36:54.1918554Z","Operation":"sample string 6","Provider":"sample string 7","Workflow":"sample string 8","RequestModel":"sample string 9","ResponseModel":"sample string 10","ServerAddress":"sample string 11","Port":1,"ErrorType":"sample string 12","InputTokens":13,"OutputTokens":14,"ReasoningTokens":15,"CustomerProvidedAccount":true}

application/xml, text/xml

Sample: 
<UpdateTokenUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.ConfigurationModels">
  <ConversationId>sample string 2</ConversationId>
  <CustomerProvidedAccount>true</CustomerProvidedAccount>
  <ErrorType>sample string 12</ErrorType>
  <Id>sample string 1</Id>
  <InputTokens>13</InputTokens>
  <Operation>sample string 6</Operation>
  <OutputTokens>14</OutputTokens>
  <Port>1</Port>
  <Provider>sample string 7</Provider>
  <QuoteId>sample string 4</QuoteId>
  <ReasoningTokens>15</ReasoningTokens>
  <RequestModel>sample string 9</RequestModel>
  <ResponseModel>sample string 10</ResponseModel>
  <ServerAddress>sample string 11</ServerAddress>
  <Timestamp>2026-10-02T23:36:54.1918554+00:00</Timestamp>
  <UserId>sample string 3</UserId>
  <Workflow>sample string 8</Workflow>
</UpdateTokenUsage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The added token usage entry.

TokenUsage
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
ConversationId

globally unique identifier

None.
UserId

globally unique identifier

None.
QuoteId

globally unique identifier

None.
Timestamp

date

None.
Operation

string

None.
Provider

string

None.
Workflow

string

None.
RequestModel

string

None.
ResponseModel

string

None.
ServerAddress

string

None.
Port

integer

None.
ErrorType

string

None.
InputTokens

integer

None.
OutputTokens

integer

None.
ReasoningTokens

integer

None.
CustomerProvidedAccount

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "06fe2ca2-edb2-4fef-81ac-8b9a1a5dbe96",
  "ConversationId": "2cc3dd59-f09c-49c6-84e4-8b35e88eef49",
  "UserId": "40279f3a-9bff-44e9-bfa5-ba617fb7725a",
  "QuoteId": "b6670bc9-71bc-43e0-9ab0-7284ead39bb4",
  "Timestamp": "2026-10-02T23:36:54.1918554Z",
  "Operation": "sample string 4",
  "Provider": "sample string 5",
  "Workflow": "sample string 6",
  "RequestModel": "sample string 7",
  "ResponseModel": "sample string 8",
  "ServerAddress": "sample string 9",
  "Port": 1,
  "ErrorType": "sample string 10",
  "InputTokens": 11,
  "OutputTokens": 12,
  "ReasoningTokens": 13,
  "CustomerProvidedAccount": true
}

text/html

Sample: 
{"Id":"06fe2ca2-edb2-4fef-81ac-8b9a1a5dbe96","ConversationId":"2cc3dd59-f09c-49c6-84e4-8b35e88eef49","UserId":"40279f3a-9bff-44e9-bfa5-ba617fb7725a","QuoteId":"b6670bc9-71bc-43e0-9ab0-7284ead39bb4","Timestamp":"2026-10-02T23:36:54.1918554Z","Operation":"sample string 4","Provider":"sample string 5","Workflow":"sample string 6","RequestModel":"sample string 7","ResponseModel":"sample string 8","ServerAddress":"sample string 9","Port":1,"ErrorType":"sample string 10","InputTokens":11,"OutputTokens":12,"ReasoningTokens":13,"CustomerProvidedAccount":true}

application/xml, text/xml

Sample: 
<TokenUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models">
  <ConversationId>2cc3dd59-f09c-49c6-84e4-8b35e88eef49</ConversationId>
  <CustomerProvidedAccount>true</CustomerProvidedAccount>
  <ErrorType>sample string 10</ErrorType>
  <Id>06fe2ca2-edb2-4fef-81ac-8b9a1a5dbe96</Id>
  <InputTokens>11</InputTokens>
  <Operation>sample string 4</Operation>
  <OutputTokens>12</OutputTokens>
  <Port>1</Port>
  <Provider>sample string 5</Provider>
  <QuoteId>b6670bc9-71bc-43e0-9ab0-7284ead39bb4</QuoteId>
  <ReasoningTokens>13</ReasoningTokens>
  <RequestModel>sample string 7</RequestModel>
  <ResponseModel>sample string 8</ResponseModel>
  <ServerAddress>sample string 9</ServerAddress>
  <Timestamp>2026-10-02T23:36:54.1918554+00:00</Timestamp>
  <UserId>40279f3a-9bff-44e9-bfa5-ba617fb7725a</UserId>
  <Workflow>sample string 6</Workflow>
</TokenUsage>