Measured usage per minute of Call, for a cost estimate before a Call

GET /v1/analytics/usage-rates

Estimates, per minute of Call, the TTS characters, model input tokens and model output tokens the caller's Organization used over the last window_days (30 when absent, at most 90), averaged over the Turns, the greeting included, of its answered Calls that ended in the window (1.28.0, workspace ADR 0077). Below the minimum Turn count (USAGE_RATES_MIN_TURNS, a target) the figures are measured over every Organization of the cell instead and basis says platform; from 1.29.0 that basis is answered only when at least 5 Organizations other than the caller's (a target) contributed a counted Call in the window, and otherwise every figure is null and both counts 0, so that no Organization learns another's averages. Every figure is an estimate measured from stored Turns, labelled with its basis and counts; it is not a price, a quote or a bill. Needs usage:read from 1.29.0 (workspace ADR 0078, decision 7), calls:read before it.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the usage:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/analytics/usage-rates" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/analytics/usage-rates`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/analytics/usage-rates",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is UsageRates.