List usage
Imports the caller org's usage for a connected third-party account.
GET /v1/ai/connections/{provider}/usage
| Address | https://api.hanzo.ai/v1/ai/connections/{provider}/usage |
| Method | GET |
| Operation | get_ai_connections_by_provider_usage |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Imports the caller org's usage for a connected third-party account. The org is resolved from the VERIFIED principal (requireConnectionOrg), so a tenant reads only its own connection. The key is unsealed SERVER-SIDE and never returned. An unconnected account, a missing importer, or a scope-denied provider all return a 200 ProviderUsage with connected/available flags + a human note — the UI's honest-empty states — never a fabricated figure.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes |
Response
| Status | Body | Meaning |
|---|---|---|
200 | Success. | |
401 | — | No credential, or one this service does not accept. |
403 | — | A valid credential that may not do this. |
200 body — 28 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | any | — | The operation's own result. |
data2 | body | any | — | A second result the operation defines, when it has one. |
msg | body | string | yes | Empty on success, the reason on failure. |
status | body | string | yes | One of ok, error. |
data.available | body | boolean | — | |
data.byModel | body | ai.ProviderUsageModelSpend[] | — | |
data.byModel[].model | body | string | — | |
data.byModel[].requests | body | integer | — | |
data.byModel[].spendCents | body | integer | — | |
data.byModel[].tokens | body | integer | — | |
data.connected | body | boolean | — | |
data.currency | body | string | — | |
data.end | body | string | — | |
data.interval | body | string | — | |
data.note | body | string | — | |
data.provider | body | string | — | |
data.series | body | ai.ProviderUsageSeriesPoint[] | — | |
data.series[].requests | body | integer | — | |
data.series[].spendCents | body | integer | — | |
data.series[].t | body | string | — | |
data.series[].tokens | body | integer | — | |
data.start | body | string | — | |
data.totals | body | ai.ProviderUsageTotals | — | |
data.totals.inputTokens | body | integer | — | |
data.totals.outputTokens | body | integer | — | |
data.totals.requests | body | integer | — | |
data.totals.spendCents | body | integer | — | |
data.totals.tokens | body | integer | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo ai connections usage <provider>import { Configuration, AiApi } from 'hanzoai';
const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAiConnectionsByProviderUsage({ provider: 'provider' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AiApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AiApi(client).get_ai_connections_by_provider_usage(provider='provider')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.AiAPI.GetAiConnectionsByProviderUsage(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, ai_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = ai_api::get_ai_connections_by_provider_usage(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AiApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new AiApi(client).getAiConnectionsByProviderUsage();curl https://api.hanzo.ai/v1/ai/connections/<provider>/usage \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for ai — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.