Read the price list

GET /v1/platform/prices

The vendor list prices the api rates usage against, with the list version; each entry says whether it was verified. List prices, not bills. From 1.38.0 (workspace ADR 0086) the entries are the vendor price rows in force at at, now when absent, and version is the UTC date of the newest effective_from among them; the history and the upcoming rows are read through GET /v1/platform/vendor-prices.

Request

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

curl "$VOCAL_API/v1/platform/prices" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/prices`, {
  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/platform/prices",
    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 PriceList.