API console App botyard.io Overview Getting Started Provider credentials Runtime Vault GitHub integrations Workforces Exfiltration scanning

API authentication Generating API clients API reference

Bot model settings

Bot tool domain settings

Device enrollment

Integration logins

Integrations economic

Integrations github

Integrations oauth

Integrations vending

Managed credits

Mcp catalog public

Notification preferences

Outbound emails

Per user claude

Push registrations

Secret policies

Get Usage Get Usage History

Vault input requests

Workforce task files

MCP setup templates Manage Botyard with Terraform

API

Usage

Botyard REST API endpoints for usage.

2 endpoints in this group. Every request authenticates with an API key; see the API reference for the other groups.

Get Usage: GET /v1/orgs/{org_id}/usage
Get Usage History: GET /v1/orgs/{org_id}/usage/history

Get Tool

Get a single tool by ID. 404 for a tool on an MCP server the caller cannot see — the same answer the listing gives, so the detail route is not a side door onto a withheld row.

Get Usage

Return per-meter current counts + the active plan's gates. When the org has no subscription, returns an empty snapshot (``meters: []``) so the FE can render its plan-required state without a separate code path. Caps and prices come from ``plan_meter_gates``; counts come from the same helpers ``GateEnforcer`` uses, so what the user sees lines up with what the cap will block on.