Enterprise Admin API
Administer ToqanClaw, Agent owner, and individual Agent budgets with an enterprise admin token.
The Enterprise Admin API lets a tenant administrator manage tenant and user budgets, review budget-increase requests, and list tenant users programmatically.
It is a separate surface from the product API:
| Product API | Enterprise Admin API | |
|---|---|---|
| Base URL | https://api.toqan.ai/api | https://api.toqan.ai/admin-api/v1 |
| Auth | API key (X-Api-Key: sk_...) | Admin token (Authorization: Bearer tqa_...) |
| Scope | One Agent | Your whole tenant |
Authentication
Every admin endpoint requires an admin token — a credential prefixed with tqa_ that is scoped to your tenant and to the roles it was granted. Send it in the Authorization header:
Authorization: Bearer tqa_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Admin tokens are distinct from the sk_ API keys used for conversations. A missing, malformed, expired, or revoked token returns 401.
Create and manage admin tokens
Admin tokens cannot be created through API calls. Sign in as a tenant administrator and open the API tokens page.
- Select Create token.
- Add an optional description and choose a lifetime.
- Create the token and copy its value.
The token value is shown once and cannot be retrieved later. Store it securely.
Use the same page to view active tokens and revoke tokens that are no longer needed.
Call the admin endpoints
Point requests at the admin base URL and pass the token:
curl -X POST https://api.toqan.ai/admin-api/v1/billing/claw/budget-requests/list \
-H "Authorization: Bearer tqa_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"status": "pending", "limit": 50, "offset": 0}'There are three budget types. Each has its own endpoints, and their user lists are never combined:
- ToqanClaw — each person's ToqanClaw budget.
- Agent owners — the budget a person shares across the Agents they own.
- Agents — the budget that belongs to one Agent. Setting it moves the Agent to the
productiontier; clearing it moves the Agent back toexperiment.
Some paths and JSON fields say spaces, space_id, or space_name. These names mean an Agent.
List users with their budget:
ToqanClaw budgets:
- Get the default ToqanClaw budget
- Set the default ToqanClaw budget
- Clear the default ToqanClaw budget
- Get a user's ToqanClaw budget
- Set custom ToqanClaw budgets
- Clear custom ToqanClaw budgets
- List ToqanClaw budget-increase requests
- Approve or reject a ToqanClaw budget-increase request
Agent owner budgets:
- Get the default Agent owner budget
- Set the default Agent owner budget
- Clear the default Agent owner budget
- Get a user's Agent owner budget
- Set custom Agent owner budgets
- Clear custom Agent owner budgets
- List Agent owner budget-increase requests
- Decide an Agent owner budget-increase request
Agent budgets:
- List Agent budgets
- Get an Agent budget
- Set an Agent budget
- Clear an Agent budget
- List Agent budget-increase requests
- Decide an Agent budget-increase request
ToqanClaw budgets on the older /tenant paths (still supported):
- Understand the user budget model
- Read budgets for specific users
- List users with a budget override
- Set budgets from up to 500 user ID entries per request
- Clear a user's budget override
- Get the tenant default user budget
- Set the tenant default user budget
- Clear the tenant default user budget
Tenant admin:
All endpoints are scoped to the tenant that owns the token; you cannot read or change another tenant's data.
Budget units: Send all budget inputs as dollar values. For example,
"budget": 100means $100.User-budget endpoints also return dollar values. Agent budget responses identify the currency in
budget_currency, and Agent budget-increase requests inapproved_budget_currency.Decimals are allowed. The API stores budget amounts to six decimal places and rejects values that round to zero.
There is no configurable business maximum. A misplaced decimal point can create an unexpectedly large budget.
Limits
Admin traffic is rate-limited per admin token. This limit is separate from the Product API conversation limit.
Updated 25 days ago