blocks.findText
Find top-level body blocks containing a literal case-insensitive substring. Matches flattened block text, coalescing repeated hits and nested table paragraphs into one block. Scans at most 20,000 blocks inside the document host and returns compact previews without transferring full-text pages.
doc.blocks.findText(…)Expected result
Returns matching-block total within the scan, limited matches with zero-based ordinals and 100-character previews, firstMatchOrdinal even for limit:0, scannedBlocks, truncated, and revision. A failed read retains completed pages and reports scanError; revision is unknown if no page succeeded. Whitespace and Unicode are not normalized.
Inputs
textstringrequiredLiteral case-insensitive substring. Whitespace is preserved.
1 additional input field
limitintegerMaximum matches. Default: 8; zero returns counts only.
Result
Output fields
totalintegerrequiredmatchesobject[]requiredfirstMatchOrdinalintegerscanErrorobjectFields
messagestringrequiredscannedBlocksintegerrequiredtruncatedbooleanrequiredrevisionstringrequiredFailures
Pre-apply throws
INVALID_INPUT
Raw schemas
Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.
View raw JSON schemas