Preview detected boxes
render_previewRender a page with the field boxes drawn on it, to verify placement.
Blue = deterministic (template/AcroForm/agent), green/orange/red = ML
confidence bands (`>= 0.7`, `0.4`–`0.7`, `< 0.4`). Labels show field ids.
The result has the image and a `preview_url` link to the same image; some
clients (e.g. ChatGPT) do not display tool images, so there the user sees
the page only through `preview_url`. Also records the field-layout visual
review receipt for `page_index` required before `fill_pdf` or `save_template`
on ML-detected layouts.
When to use:
- Use `render_preview` to inspect empty field box positions, IDs, false
positives, and missed inputs before filling or after modifying geometry with
`add_field`, `update_field`, `update_fields`, `remove_field`, `remove_fields`,
or `prune_fields`.
- Use `render_filled_preview` instead to see actual field values typeset inside
those boxes and check for text overflow before calling `fill_pdf`.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspace_id": "<workspace_id>"
},
"name": "render_preview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page_index | No | 0-based page index (`0` to `page_count - 1`) to render with field bounding-box overlays. | |
| workspace_id | Yes | Active workspace ID returned by `open_pdf` (`summary.workspace_id`). |