API overview
Read what your organisation's agents spent, for a dashboard of your own. Every request carries a reading api key, its name in the X-Api-Key header and its secret in X-Api-Secret, and names your organisation in the path; a request naming any other is refused. Every method reads except Report a bill, which takes a recording key; recording calls happens through the recorder library over gRPC. Every reply carries X-Request-Id and, where a rate limit applies, RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset.
Keys
| Header | What it carries |
|---|---|
X-Api-Key |
A read key's name, issued on the console's API keys page. A write key is refused here. |
X-Api-Secret |
The same key's secret, shown once when the key is created. |
Methods
| Method | Request | What it does |
|---|---|---|
| List activities | GET /v1/organisations/{organisation}/activities, GET /v1/organisations/{organisation}/workspaces/{workspace}/activities |
Individual model and tool calls, newest first. |
| Aggregate spend | GET /v1/organisations/{organisation}/activities:aggregate, GET /v1/organisations/{organisation}/workspaces/{workspace}/activities:aggregate |
Spend grouped by agent, customer, user, model, day and more. |
| List agents | GET /v1/organisations/{organisation}/agents |
The agents recording under your organisation. |
| List users | GET /v1/organisations/{organisation}/users, GET /v1/organisations/{organisation}/workspaces/{workspace}/users |
The names your agents have sent for user identifiers. |
| List outcomes | GET /v1/organisations/{organisation}/outcomes, GET /v1/organisations/{organisation}/workspaces/{workspace}/outcomes |
Units of business work counted against a request. |
| List prices | GET /v1/priceableUnits |
The rate card every call is priced against. |
| Report a bill | POST /v1/organisations/{organisation}/reconciliations:reportBill |
Send a day of your Google bill and get each hour and model compared. |
OpenAPI document
Every method, parameter and field: openapi.yaml or openapi.json.