Locate text within a PDF and return bound locators.
Use describe("pdf.inspect.find") when your code needs the complete live JSON Schemas.
At a glance
| Property | Value |
|---|---|
| Package | @runstamp/pdf |
| Domain / verb | pdf / inspect |
| Customer jobs | read, review |
| Deterministic | Yes |
| Side effects | none |
Availability
| Local | SDK | CLI | MCP | Managed API |
|---|---|---|---|---|
| public ga | public ga | public ga | public ga | public ga |
Managed API route: POST /api/v2/operations/pdf/inspect/find. Managed execution requires a free-trial workspace or an active Platform or Enterprise workspace, and an environment-bound API key.
Input and result
| Schema | Required fields | Optional fields |
|---|---|---|
| Input | pdfBase64, query | none |
| Options | operation | deterministic, deterministicSeed, timeoutMs, locale, lossPolicy, limits |
| Result value | output, artifacts | none |
Every success also carries losses, diagnostics, and a hash-bound receipt.
Defaults, limits, and format constraints
Defaults
| Path | Default |
|---|---|
$.deterministic | default=true |
$.lossPolicy | default="collect" |
Formats and profiles
No separate format selector is declared. Accepted artifacts are bounded by the exact input schema.
Other limits
| Path | Constraint |
|---|---|
$.pdfBase64 | minLength=8maxLength=89478488 |
$.query | minLength=1maxLength=16384 |
$.timeoutMs | minimum=1maximum=600000 |
$.limits.maxInputBytes | minimum=1maximum=67108864 |
$.limits.maxOutputBytes | minimum=1maximum=134217728 |
$.limits.maxPages | minimum=1maximum=2000 |
$.limits.maxElements | minimum=1maximum=250000 |
$.limits.maxArchiveEntries | minimum=1maximum=250000 |
$.limits.maxExpansionRatio | minimum=1maximum=1000 |
$.limits.maxDurationMs | exclusiveMinimum=0maximum=600000 |
Invoke
const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/pdf/pdf.inspect.find/input.json").then((response) => response.json());
const result = await runstamp.run("pdf.inspect.find", input);
if (!result.ok) throw new Error(`${result.error.code}: ${result.error.remediation}`);
console.log(result.value, result.losses, result.diagnostics, result.receipt);curl -fsS https://runstamp.com/demo-evidence/operation-evidence/pdf/pdf.inspect.find/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke pdf.inspect.find --input input.json{
"tool": "runstamp_invoke_operation",
"arguments": {
"operation": "pdf.inspect.find",
"input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/pdf/pdf.inspect.find/input.json>",
"execution_mode": "local"
}
}Errors and losses
Declared errors (12)
pdf/INVALID_INPUTpdf/RESOURCE_LIMITpdf/PDF_RESOURCE_LIMITpdf/TIMEOUTpdf/PDF_UNSUPPORTEDpdf/SCHEMA_REJECTEDcommon/SCHEMA_REJECTEDcommon/OPERATION_CANCELLEDcommon/OPERATION_TIMEOUTcommon/CONTRACT_VIOLATIONcommon/RESOURCE_LIMIT_EXCEEDEDpdf/LOSS_POLICY_VIOLATED
Declared losses (12)
pdf/PDF_ACTIVE_CONTENT_REMOVEDpdf/PDF_APPEARANCE_GENERATEDpdf/PDF_ANNOTATIONS_STRIPPEDpdf/PDF_ATTACHMENTS_STRIPPEDpdf/PDF_FORM_INTERACTIVITY_STRIPPEDpdf/PDF_GEOMETRY_APPROXIMATEDpdf/PDF_GRAPHICS_NOT_PRESERVEDpdf/PDF_METADATA_STRIPPEDpdf/PDF_OCR_REQUIREDpdf/PDF_REDACTED_CONTENT_REMOVEDpdf/PDF_SIGNATURE_INVALIDATEDpdf/PDF_TEXT_UNDECODABLE
SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.
Verified example and exact contract
- Fixture:
icp-workflow(PDF rendered from the ITGC audit source). - Example input — SHA-256
610ee38e1c4aeb1fb4be9bc567132d478a3852619d9df4d874ddc90f9ef04e81. - Example result — SHA-256
e1631cfca66d6ca552955ed98d8cb33eaffa177ad0addf8b24f6de3953970985. - Verified result SHA-256:
6230dcf9d1c02282dcf371e6008475e8d1b75d3c0fb55f31b49e476228616116. - Qualification lane:
11-pdf-xlsx.
Contract fingerprints
- Descriptor:
ab1c0a802db25468007da7569a70834e6c8b110d2b3f370998d0fc7db809f163. - Input schema:
2576373aae2f29fa1b8dffc4f65940a02d3e4e2994d4c83713446f69f5c2d8d2. - Options schema:
da5ff26344849e895f592d800d42236edcb30c59dabe74fc300d55f5ee2d079d. - Result value schema:
3175064eece1cb63036b4011910b353da8a51f0dad3142b1a9d059fae39166e2.
The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.