API
Management keys
Manage workspace API keys, spending limits and reports.
Last updated on
A management key lets your server manage inference keys and read workspace spending. Use an ordinary API key to call models.
Create a management key
- Open Management keys in the cabinet.
- Select your personal workspace or organization.
- Create a key with a descriptive name.
- Save the key secret in your server’s secret store.
Each key is bound to one workspace. Create another key for a different workspace. Do not use scope or X-Org-Id to switch it. Keep the secret out of browser code and repositories.
API reference
| Endpoint | Purpose |
|---|---|
GET /v1/key | Get current key |
GET /v1/keys | List API keys |
POST /v1/keys | Create an API key |
GET /v1/keys/{hash} | Get an API key |
PATCH /v1/keys/{hash} | Update an API key |
DELETE /v1/keys/{hash} | Delete an API key |
GET /v1/credits | Get top-ups and spending |
GET /v1/analytics/meta | Get analytics metadata |
POST /v1/analytics/query | Query analytics |
GET /v1/activity | Get daily activity |
GET /v1/generation | Generation metadata and charges |
Choose the credential
| Task | Credential |
|---|---|
POST /v1/chat/completions, /v1/responses, /v1/messages | Inference key |
GET /v1/balance, GET /v1/usage | Inference key |
| Key management and workspace reports | Management key |
GET /v1/key, GET /v1/generation | Either kind, within its access boundary |
Balance and spending
- Available balance:
availableBalancein GET /v1/balance, after reservations. - Remaining key allowance:
limit_remainingand exactspend_limitsamounts in GET /v1/key. This is a key ceiling, not the workspace balance. - All-time top-ups and spending: GET /v1/credits.
- Individual request charge:
usage.costand provod.billing.total_charge. JSON, SSE and disconnect recovery.
Permissions and revocation
Create and revoke management keys in the cabinet using a web session. Organization permissions are managementKeys.read, managementKeys.create and managementKeys.revoke; do not send them with Bearer requests. Public methods check the owner’s current access. Revocation is permanent.