Valuein
Discovery

Save Figure Review

save_figure_review
Benchmark and above

Record (or update) the review state of ONE figure inside a report — the durable answer to 'has a human traced this number back to its filing?' Upsert keyed on (report_id, figure_key): re-reviewing a figure REPLACES its prior mark, it never appends, so this is always the figure...

Example Call

example_call.pypython
# Using the Valuein MCP server from Python (via MCP SDK)# Or call directly from Claude / Cursor after setup result = await client.call_tool(    "save_figure_review",    arguments={    "report_id": "EXAMPLE",    "figure_key": "EXAMPLE",    "state": "verified"})print(result)

Direct tool call:save_figure_review(...)

Inputs

ParameterTypeRequiredDescription
report_idstring
required
Identifier of the report the figure belongs to, as returned by create_report / list_my_reports / save_freeform_report.
figure_keystring
required
Opaque id you mint for one figure inside the report. Never parsed or validated beyond length — use the exact same key to update this figure's review later. Shape for a dataset-backed figure: 'fact:{fact_id}#{figure}', the figure lowercased and whitespace-collapsed as the report writes it ('fact:f_rev#$402.83b'); the Workspace mints 'raw:{hash}' for a figure with no fact, which only it can compute.
state"verified" | "corrected" | "external" | "rejected"
required
verified = traced to its filing and correct. corrected = wrong (supply corrected_value). external = legitimately not from Valuein data (analyst's own source). rejected = unsupported, should be removed from the report.
notestringoptionalOptional free-text reviewer note (e.g. what was checked, or why it was rejected).
corrected_valuestringoptionalThe correct value. REQUIRED when state='corrected'; must be omitted for every other state (a corrected_value on a non-corrected review is rejected).

Output Fields

okreview

Example Response

Illustrative
response.jsonjson
{  "ok": null,  "review": null}

Shape only — field names match the live schema; values are placeholders, not real filings. See MCP server for the structured response shape.

Notes

Available from the Benchmark plan and above.

Try this tool

Get tokenAll tools
CategoryDiscovery
PIT-safeNo
Min planBenchmark
Inputs5 (3 required)

Plan Access

Sample (guest)
Not included
Benchmark (token)
Available
Pro
Available
Institutional
Available

Index names are trademarks of their owners; Valuein is not affiliated with or endorsed by any index provider.