excited.liveexcited.live
API reference

API reference

REST endpoints for every entity: accounts, subscriptions, hardware, revenues, liabilities, transfers, plan and settings.

REST API behind excited.live. Every endpoint is under /api/v1 and scoped to the authenticated user.

Authentication. Send Authorization: Bearer <token> (a Better Auth session token or API key) or, for an API key, x-api-key: elk_…. A key resolves here exactly as it does on /mcp, with the same scopes: a missing scope is 403 insufficient_scope naming the scope, and key minting plus account settings need a browser session (403 session_required). Authorization: ApiKey … is not accepted. On environments where auth is not configured (local dev, previews) the API trusts an x-user-id header instead, and falls back to a shared default bucket.

Cost. excited.live is free during launch: no card is required and nothing is charged today. There is no trial end date, no automatic charge, and no plan, seat or usage fee. The machine-readable answer is https://excited.live/pricing.md

Examples use $API_URL for the API base URL and $TOKEN for your bearer token. The machine-readable document is the committed apps/api/openapi.json.

Endpoints

MethodPathSummary
GET/healthHealth check
GET/api/v1/accounting/entitiesList entities
POST/api/v1/accounting/entitiesCreate a business entity
GET/api/v1/accounting/entities/{id}Get an entity
PATCH/api/v1/accounting/entities/{id}Update an entity
DELETE/api/v1/accounting/entities/{id}Delete a business entity
GET/api/v1/accounting/assetsList assets
POST/api/v1/accounting/assetsCreate an asset
GET/api/v1/accounting/assets/{id}Get an asset
PATCH/api/v1/accounting/assets/{id}Update an asset
DELETE/api/v1/accounting/assets/{id}Delete an asset
GET/api/v1/accounting/incomesList incomes
POST/api/v1/accounting/incomesCreate an income
GET/api/v1/accounting/incomes/{id}Get an income
PATCH/api/v1/accounting/incomes/{id}Update an income
DELETE/api/v1/accounting/incomes/{id}Delete an income
POST/api/v1/accounting/incomes/careerSet the career salary
GET/api/v1/accounting/expensesList expenses
POST/api/v1/accounting/expensesCreate an expense
GET/api/v1/accounting/expenses/{id}Get an expense
PATCH/api/v1/accounting/expenses/{id}Update an expense
DELETE/api/v1/accounting/expenses/{id}Delete an expense
GET/api/v1/accounting/liabilitiesList liabilities
POST/api/v1/accounting/liabilitiesCreate a liability
GET/api/v1/accounting/liabilities/{id}Get a liability
PATCH/api/v1/accounting/liabilities/{id}Update a liability
DELETE/api/v1/accounting/liabilities/{id}Delete a liability
GET/api/v1/accounting/liabilities/{id}/scheduleGet a liability’s month-by-month schedule
GET/api/v1/accounting/transfersList transfers
POST/api/v1/accounting/transfersCreate a transfer
GET/api/v1/accounting/transfers/{id}Get a transfer
PATCH/api/v1/accounting/transfers/{id}Update a transfer
DELETE/api/v1/accounting/transfers/{id}Delete a transfer
GET/api/v1/accounting/summaryGet wealth metrics and balance sheet per entity and consolidated
GET/api/v1/accounting/ledger/{yearMonth}Get computed monthly ledger
GET/api/v1/accounting/cash-flowsGet the cash-flow feed for a month
GET/api/v1/accounting/projectionGet treasury balance per month around a centre month
GET/api/v1/agent-keysList agent API keys
POST/api/v1/agent-keysMint an agent API key
DELETE/api/v1/agent-keys/{id}Revoke an agent API key
GET/api/v1/auth/meCurrent session
GET/api/v1/catalog/suggestSearch the catalog
POST/api/v1/catalog/resolveResolve autofill values
GET/api/v1/onboardingGet onboarding state
PUT/api/v1/onboardingSave onboarding state
GET/api/v1/settingsGet settings
PUT/api/v1/settingsSave settings

On this page