List fields
list_fieldsList the current working fields and workspace summary for an open PDF workspace.
Returns `{"summary": ..., "fields": [...]}` for `workspace_id`, reflecting any
in-workspace edits made via `add_field`, `update_field`, `update_fields`,
`remove_field`, `remove_fields`, or `prune_fields`. Each field entry includes
`id`, `name`, `type`, `page_index` (0-based), bounding-box percentages
(`x`, `y`, `w`, `h`), `confidence`, `source` (`'template'`, `'acroform'`,
`'ml'`, or `'agent'`), and `needs_name_review`.
Filtering: pass a 0-based `page_index` to return only the fields on that
single page, or omit `page_index` (pass `None`) to list fields across all
pages in the workspace.
When to use:
- Use `list_fields` to inspect current field IDs, coordinates, or labels in an
already-open workspace (for example, after editing fields or narrowing to one
page) without re-running detection.
- Use `open_pdf` to load a document for the first time and create a workspace.
- Use `list_templates` to list saved, reusable account-level templates rather
than the fields of an active workspace.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page_index | No | Optional 0-based page index (`0` to `page_count - 1`) to filter fields to a single page. Omit or pass `None` to list fields across all pages in the workspace. | |
| workspace_id | Yes | Active workspace ID returned by `open_pdf` (`summary.workspace_id`). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||