Open the financial workspace with the context and factual state needed to continue useful work.
Return workspace context, financial position, approved state, new activity, this week's review, watches, due notes, factual attention, and executable next actions. data.agent_brief comes first and is always present, empty when nothing applies; each entry is a standing instruction about the agent's own upkeep, such as filling an open household fact from the records, with a stable code, the instruction, what it is about, and the next_actions command that carries it out. On the first opening, an opening with no checkpoint, one whose checkpoint is 30 days old, or one with more changes than the bounded count, data.first_pass carries the first pass computed in Candor, each block as columns and rows. months has income, spending, debt payments, and net for up to 24 months with a monthly average over full months and the top spending categories; accounts has each account's name, institution, role, balance, and for cards and loans the rate, required payment, due date, and interest charged over the last 12 months; recurring has active, lapsed, and candidate series. Other openings carry first_pass null. The opening keeps four lists apart, each listing everything it read, and each section that lists something carries about, one sentence on what it holds and what to do with it. review is the latest weekly review, null before the first, with reviewed_on, stale (true once the review is more than eight days old, so it is no longer this week's), quiet_reason (why a review that raised no areas was quiet, otherwise null), and its review.area items (what Candor noticed, why it matters, what is not known, the records behind it as basis, and a reviews.update action that names the area) and review.gap items (the facts worth settling and how to record each). watches are what the agent's own watches came to. due_notes are the agent's notes whose revisit date has come. attention is the factual signals Candor computes, such as a payment due soon, a budget line over, or a stale connection. reviews.list reads earlier reviews, and reviews.update records what came of an area. attention.evidence_guide and attention.fact_questions are empty and attention.states is null; they stay only for older clients. context_needed lists the uncovered standard topics. data.help_depth is how much help the user wants, in_depth by default or essentials when the user asked not to be asked about goals or their household; with essentials, context_needed is empty, the brief keeps to what needs action, and review gaps still list, to settle from the records rather than ask. preferences.update changes it on the user's word. The checkpoint for this opening is data.new_since_checkpoint.checkpoint_candidate. When nothing is new since the last checkpoint, the opening records it itself and new_since_checkpoint.checkpoint_recorded is true. Otherwise the same value is carried as args.checkpoint on the open.acknowledge entry in next_actions, so find that entry by command rather than by position, and acknowledge that exact checkpoint after processing the opening; acknowledgement does not resolve attention or due notes.
Request
- Base URL: https://api.candor.money
- URL: https://api.candor.money/v1/open
- Auth: HTTP bearer
Response
Workspace opening envelope.
Changes
No recorded changes to this operation across all 1 revision of this API.