Usage API
Generated OpenAPI reference for the Usage API surface.
Overview
Usage endpoints are part of the public Everyn API. Organization usage and funding reads: the browser workspace usage snapshot and the machine-readable managed-AI balance preflight (runs:read). The execution-safe balance is advisory — settlement drains asynchronously after runs complete.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.
The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.
Endpoint summary for quick scanning before using the generated reference:
| Method | Path | Purpose | Authentication | Request body / schema | Success response / schema | Errors |
|---|---|---|---|---|---|---|
GET | /v1/organizations/{organization_id}/usage | Get Workspace Usage | Bearer token (BearerAuth) | None. | 200 application/json: WorkspaceUsageResponse or WorkspaceUsageUnavailableResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/usage/balance | Get Managed Ai Balance | Bearer token (BearerAuth) | None. | 200 application/json: ManagedAiBalanceResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...