UsageRates
Estimates of what a minute of Call uses (1.28.0): TTS characters, model input tokens and model output tokens per minute of Call, averaged over the stored Turns of a window, on the Organization's own Calls or, below the minimum Turn count, on every Organization's. The console multiplies them by a voice's and a model's list prices, and adds an STT price per audio minute, to estimate a minute's cost before a Call; each figure, and every amount derived from it, is an estimate with its basis, never a price or a bill. From 1.29.0 the route needs usage:read, and the platform basis is withheld unless at least 5 Organizations other than the caller's (a target) contributed a counted Call in the window.
An object with 10 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
basis | UsageRatesBasis | yes | |
calls_counted | integer | yes | The answered Calls that ended in the window behind the figures, on the basis, less those whose Agent ran a stage on the mock Provider; their minutes from answer to end are the denominator. |
computed_at | Timestamp | yes | When the api computed the figures. |
estimate | true | yes | Always true: every figure is an estimate measured from stored Turns, not a price, a quote or a bill. |
llm_tokens_in_per_minute | number or null | yes | An estimate: the model input tokens of every model round per minute of Call, summed over the counted Turns and divided by the minutes of the counted Calls, on the basis; null when no Call minute was counted. It estimates what a future Call uses from what earlier Calls used, and is never a price or a bill. |
llm_tokens_out_per_minute | number or null | yes | An estimate: the model output tokens of every model round per minute of Call, summed over the counted Turns and divided by the minutes of the counted Calls, on the basis; null when no Call minute was counted. It estimates what a future Call uses from what earlier Calls used, and is never a price or a bill. |
object | "usage_rates" | yes | |
tts_characters_per_minute | number or null | yes | An estimate: the characters of reply text sent to TTS per minute of Call, summed over the counted Turns and divided by the minutes of the counted Calls, on the basis; null when no Call minute was counted. It estimates what a future Call uses from what earlier Calls used, and is never a price or a bill. |
turns_counted | integer | yes | The Turns with usage of the counted Calls, the greeting included, behind the figures, on the basis. |
window_days | integer | yes | The window the figures were measured over, in days back from computed_at. |
Used by
The operations whose parameters, request body or responses name this shape directly.