Manage budgets and categorize transactions with your own agent.

Returns the existing personal accounts and enabled shared joint accounts visible to the signed-in user. Partner personal accounts are excluded. Each row has an opaque accountRef, saved account and institution labels, accountType, ownership, source, native balance and currency when known, lastBalanceUpdatedAt, and connectionState. isGoalSavingsSource shows whether the account contributes to goal savings.

Account reads are cache-only and do not contact a bank or refresh balances. asOf is the response time, not a balance timestamp. Balances are never converted or combined, and missing values are null. Provider account IDs, account numbers, sort codes, and IBANs are not returned.

/api/agent/v1/accounts/:accountRef accepts strict partial updates. Manual accounts can change institution, name, currency, and ownership. Balance-only accounts can also change balance, Savings/Investments type, and goal-savings membership. Connected accounts support goal-savings membership only.

DELETE archives an owned manual account without deleting its transaction, import, balance, or categorisation records. There is no restore command. Shared, disconnected, or inaccessible accounts return Account not found. The CLI previews PATCH and DELETE locally until you add --apply.

Reads one personal or joint budget period. The response includes periodStatus, currency, the effective plan, stored funding when available, categories, line items, and planned pence. Historical reads require their frozen snapshot. The API does not calculate spent or available balances from transactions.

PATCH accepts 1 to 100 existing category and line-item pairs with plannedPence. It builds a complete selected-period budget, then overwrites that period and every explicit future plan. A later update starts a new overwrite boundary. Historical periods cannot be changed.

Returns caller-owned linked investment accounts with Coinbase, Trading 212, and other SnapTrade holdings nested beneath each account. Filter with accountRef or sloth-agent investments --account-ref. Manual holdings, activities, and partner-owned accounts are excluded.

Investment reads are cache-only and do not contact SnapTrade. Holding values stay in their provider-native currencies and may not reconcile to a converted account total. Symbols can be missing, and non-zero cash appears as a cash holding.

Lists goals or creates one. Creates require a positive target amount and goalType set to keep or spend. Results include goalType and nullable spentAt. Update and delete requests use /api/agent/v1/goals/:goalId. Goal writes are limited to the signed-in user's goals. Active shared pot target amounts stay app-managed so account balances can be reconciled across goals in priority order. A standalone priority PATCH uses a one-based position and shifts the intervening goals automatically. A Spend goal can be marked spent or restored with isSpent. Keep goals cannot be marked spent, and a spent goal must be restored before its type changes.

Returns visible categories and budget line-item options for personal and joint scopes. POST creates a custom category. PATCH requests use /api/agent/v1/categories/:categoryId and rename user-created categories; built-in categories are immutable.

A category is the broader parent. A line item is a child within one category. Names such as Other may repeat: Bills → Other and Subscriptions → Other are different choices. Use the map matching the transaction scope, and keep categoryId and lineItemId together.

Creates a zero-value line item in a personal or joint budget. Rename requests use /api/agent/v1/line-items/:lineItemId. Both require the parent categoryId and scope. Changes update the current period and explicit future plans; historical snapshots remain unchanged.

Returns booked transactions with an opaque transactionRef. Filter by date range, search text, account, category, line item, or uncategorized state. Use --line-item-id in the CLI or lineItemId over HTTP. When combined with categoryId, both IDs must match the same assignment or split.

Personal and joint category assignments are separate. A personal assignment uses the transaction's top-level categoryId, lineItemId, and categorySplits. A joint-budget assignment uses the corresponding fields under jointBudgetContribution.

A transaction can be uncategorised personally while its joint-budget contribution is already categorised. To assess its categorisation, inspect both locations. Use assignmentScope=joint to select the joint fields on eligible shared personal-account transactions.

The first transaction read each UTC day may refresh linked bank data. The response includes structured refresh status and still returns readable cached transactions if refresh work continues or fails.

Reads or updates the linked setting that includes shared personal-account portions in the joint budget. PUT accepts exactly includeSharedPersonalTransactions and returns 409 when there is no active joint budget. The CLI does not wrap this setting.

Creates a 72-hour partner clarification link for one booked partner-shared or joint transaction. The response includes a shareable message and link.

Applies 1 to 100 category assignments. The response may contain mixed successes and failures, so inspect every result.