Return usage metrics for the authenticated workspace.
Returns current-period cost, document count, and daily query count for the caller's workspace. All values are scoped to the tenant derived from the Bearer API key (RLS enforced). Response time target: p95 < 100ms.
Request
- Base URL: https://api.andish.ru (the document declares no server; this is the origin it was published from)
- URL: https://api.andish.ru/v1/workspace/usage
- Auth: none declared
Response
Successful Response
ISO year-month for which usage is aggregated (e.g. '2026-04').
Sum of cost_rub from usage_events for the current calendar month. Decimal-as-string per ADR-014 §Wire format.
Monthly cost cap in rubles (Decimal-as-string per ADR-014). Null means no cap (Enterprise). For a tier with a monthly ceiling (free: 300 RUB, ADR-083) this is the REAL ceiling the server enforces (402 cost_cap_monthly_exceeded). For every other tier it is the display-only approximation cost_cap_rub_daily × 30 — nothing checks it.
Per-workspace daily cost cap in rubles (Decimal-as-string per ADR-014). Null means no cap (free_byok uses BYOK key — no managed LLM cost; Enterprise is invoiced separately). Non-null for free (30 RUB)/trial/start/team/business tiers.
cost_current_rub / cost_cap_rub × 100. 0.0 when cap is null (Enterprise). May exceed 100 when overage.
Places the workspace's documents take in the document limit: cards a person sees (simple documents and large documents, a large document counts once, not its parts), not deleted, status != 'failed'. Available immediately after upload — before indexing completes.
Count of documents that can already be asked about: cards with status 'indexed', or a large document that is 'partial' with at least one indexed part. A large document counts once. Never above documents_uploaded; reaches it once indexing completes.
Count of completed documents in workspace (same number as documents_processed). Deprecated alias for documents_processed — kept for backward compat until 2026-06-01; use documents_processed instead.
Document count cap for this tier (from TierConfig.docs_cap). Null for Enterprise (unlimited).
Number of queries issued today UTC (Redis counter).
Daily query cap for this tier (from TierConfig.queries_per_day). Null for Enterprise (unlimited).
Current tenant billing tier (US-29). One of: free, free_byok, trial, start, team, business, enterprise. free (ADR-083) has no end date; trial and free_byok are legacy values that migration 047 moves to free.
Derived lifecycle state (ADR-058 §1). 'trial_active' — trial running (trial_ends_at in the future). 'trial_expired' — trial ended (or legacy NULL trial_ends_at); blocked unless a key is connected. 'active' — free (no end date, ADR-083), free_byok or any paid tier. Combine with byok_key_set to render the three /plan states without guessing.
Deprecated (ADR-083): trial expiry of a legacy trial. Null for every tenant on the free tier (no end date). Kept until the next API version (ADR-012).
Whether the tenant has its own LLM provider configured (byok_provider IS NOT NULL — includes Ollama BYOK without a key).
Live sum of stored document ciphertext bytes (non-failed, non-deleted documents).
Hard storage cap in bytes for this tier (ADR-058 §5; 500 MB for free/trial/free_byok). Null for Enterprise (unlimited).
Per-file upload size cap in MB for this tier (TierConfig.file_size_cap_mb). Null = unlimited (Enterprise).
Next UTC midnight when monthly cost period resets.
Count of documents with last_queried_at IS NULL (never cited by any query).
Count of documents not cited in the last 90 days (last_queried_at < now - 90 days, or never queried).
Changes
No recorded changes to this operation across all 1 revision of this API.