Get figure
well_get_figureMeasure the business's runway (how long the cash lasts), cash position (the cash it holds now) or average monthly burn, as it stands now, with every check the skill for that figure runs, in one call.
It does not take a forecast or a scenario (a hire, a new cost, a change of revenue: "what if", "if I hire"), a period in the past, one account, one category, a named company, or an explanation of a figure. Its line states the figure as it stands, so it is not a base for a scenario either.
successtrue:cardnames the card tool that draws the figure (card.tool) and the input to draw it with (card.input).answer_lineis the skill's answer line, filled inlanguage.successfalse: the figure was not measured.reasonnames the check or step that stopped it.skillis the slug of the skill that measures the figure with its full steps.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| figure | Yes | "runway" for the months of cash left; "cash_position" for the cash held now; "avg_burn" for the average monthly burn. A question about the cash and the runway together is "runway": the runway line states the cash too. | |
| language | Yes | The language of your answer. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| card | No | The card tool that draws the figure, and the input to draw it with. Present when `success` is true. | |
| skill | No | The slug of the skill that measures the figure with its full steps. Present when `success` is false. | |
| figure | Yes | ||
| reason | No | The check or step that stopped the measure. Present when `success` is false. | |
| success | Yes | ||
| answer_line | No | The skill's answer line, filled in `language`. Present when `success` is true. | |
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |