Find the operation your product needs. Then read its exact input, options, result, errors, losses and defaults with describe() (SDK), ops describe (CLI) or runstamp_describe_operation (MCP) before you invoke it.
The catalog below is generated from the Runstamp registry. Each operation links to its own reference page.
Managed API access and keys
The V2 operation route is the canonical contract for authenticated managed execution. Free-trial workspaces and active Platform and Enterprise workspaces use an environment-bound API key. List operations at /api/v2/operations. Each operation has a matching GET metadata route. The checked machine contract is at /api/v2/openapi.
Public GA means the operation is supported on the named execution surface.
Managed API authentication. Managed routes need a free-trial workspace or an active Platform or Enterprise workspace, and an environment-bound API key.
All listed operations are public GA through local packages, the SDK, CLI, MCP server, and authenticated Managed API.
Two terms used in the tables. A deterministic operation returns byte-identical output for byte-identical input, so you can cache and diff it. A loss code reports what a conversion or change may remove or alter.
Find an operation
41 stable operations · 7 packages · 5 domains.
Choose an operation below for a focused reference page. Each page contains the human-readable contract; the exact JSON Schemas remain available through describe and the machine reference.
A domain is not a package. pdf is served by both @runstamp/pdf and
@runstamp/forms, and common by whichever extensions declare it — the operation carries its
own module while the operation interface stays consistent as the catalog grows.
common — 7 operations
Verbs: convert, parse, render, transform, validate.
| Operation | What it does | Package |
|---|---|---|
common.convert.review-sidecar | Write a review set out as a sidecar artifact. | @runstamp/review-operations |
common.parse.review | Read a document's native annotations into a review set. | @runstamp/review-operations |
common.render.provenance-record | Create a canonical root provenance record for an artifact. | @runstamp/provenance |
common.render.provenance-report | Render a secret-safe human-readable lineage report. | @runstamp/provenance |
common.transform.provenance-append | Append a record to a lineage, binding it to its parent records. | @runstamp/provenance |
common.validate.provenance | Verify a lineage's record and parent bindings offline. | @runstamp/provenance |
common.validate.review-sidecar | Check a review sidecar still binds to its source document. | @runstamp/review-operations |
docx — 8 operations
Verbs: convert, diff, inspect, parse, render, transform, validate.
| Operation | What it does | Package |
|---|---|---|
docx.convert.pdf | Convert a Word document to PDF, reporting every bridge approximation as a loss. | @runstamp/docx |
docx.diff | Compare two Word documents and return the revision with tracked changes applied. | @runstamp/docx |
docx.inspect.controlled | Inspect a controlled Word document's parts and relationships. | @runstamp/docx |
docx.inspect.find | Locate text in a Word document and return bound locators. | @runstamp/docx |
docx.parse | Convert a Word document model into the shared structured model. | @runstamp/docx |
docx.render | Render a structured document to a native Word (.docx) file. | @runstamp/docx |
docx.transform.html | Convert an HTML string into a Word document, reporting unsupported constructs. | @runstamp/docx |
docx.validate | Check a Word document for schema and content defects without modifying it. | @runstamp/docx |
pdf — 15 operations
Verbs: convert, extract, inspect, render, repair, transform, validate.
| Operation | What it does | Package |
|---|---|---|
pdf.convert | Export a sanitized derivative of a PDF, without active content. | @runstamp/pdf |
pdf.extract.form-fields | Extract field values from an AcroForm. | @runstamp/forms |
pdf.extract.signatures | Extract digital signature records from PDF bytes. | @runstamp/pdf |
pdf.inspect.evidence | Inspect a PDF's evidence structure without executing active content. | @runstamp/pdf |
pdf.inspect.find | Locate text within a PDF and return bound locators. | @runstamp/pdf |
pdf.inspect.form | Describe an AcroForm's fields and structure. | @runstamp/forms |
pdf.inspect.form-map | Return a field map for an AcroForm without modifying it. | @runstamp/forms |
pdf.render | Render a structured document to a native PDF file. | @runstamp/pdf |
pdf.repair | Repair structural defects in PDF bytes, reporting every change as a loss. | @runstamp/pdf |
pdf.transform | Apply a bounded in-format mutation to PDF bytes, such as linearization. | @runstamp/pdf |
pdf.transform.form-fill | Fill an AcroForm's fields, keeping it interactive. | @runstamp/forms |
pdf.transform.form-flatten | Flatten an AcroForm so its values become page content. | @runstamp/forms |
pdf.validate | Check PDF bytes for conformance defects without modifying them. | @runstamp/pdf |
pdf.validate.form | Check an AcroForm's fields against its declared constraints. | @runstamp/forms |
pdf.validate.form-integrity | Verify an AcroForm is unchanged from its bound hash. | @runstamp/forms |
pptx — 4 operations
Verbs: convert, render, repair, validate.
| Operation | What it does | Package |
|---|---|---|
pptx.convert.pdf | Convert a deck to PDF, reporting every approximation as a loss. | @runstamp/pptx |
pptx.render | Render a structured document to a native PowerPoint (.pptx) deck. | @runstamp/pptx |
pptx.repair | Repair structural defects in PowerPoint bytes, reporting every change as a loss. | @runstamp/pptx |
pptx.validate | Check PowerPoint bytes for structural defects without modifying them. | @runstamp/pptx |
xlsx — 7 operations
Verbs: convert, inspect, parse, render, repair, transform, validate.
| Operation | What it does | Package |
|---|---|---|
xlsx.convert | Export a workbook to the requested target form. | @runstamp/xlsx |
xlsx.inspect | Estimate the cost and shape of a render without producing the workbook. | @runstamp/xlsx |
xlsx.parse | Read workbook bytes into the structured model. | @runstamp/xlsx |
xlsx.render | Render a structured document to a native Excel (.xlsx) workbook. | @runstamp/xlsx |
xlsx.repair | Repair defects in workbook bytes, reporting every change as a loss. | @runstamp/xlsx |
xlsx.transform | Map or apply independently verified bounded changes to an existing workbook. | @runstamp/xlsx |
xlsx.validate | Lint a spreadsheet document, or inspect workbook bytes, without modifying either. | @runstamp/xlsx |
One contract on five surfaces
All 41 operations are public GA on every supported execution surface. The descriptor, result envelope, declared errors, and declared losses stay the same.
| Surface | How to discover and run | Availability |
|---|---|---|
| Local package | Import the binding package | Public GA |
| SDK | describe() and run() | Public GA |
| CLI | ops describe and ops invoke | Public GA |
| MCP | runstamp_list_operations, runstamp_describe_operation, and runstamp_invoke_operation | Public GA |
| Managed API | POST /api/v2/operations/{domain}/{verb} | Public GA for free-trial workspaces and active Platform and Enterprise workspaces |
Managed operation routes use an environment-bound API key. MCP exposes three progressive tools rather than creating one top-level tool per operation.
Result, failure, and loss contract
A successful operation returns ok, value, losses, diagnostics, and a hash-bound receipt. A failure returns ok, error, losses, diagnostics, and a receipt when one can be bound.
Every error code is declared by the operation descriptor and enforced by conformance gate C5. 33 of 41 operations declare at least one possible fidelity loss, so callers can set a loss policy before execution.
Each operation page summarizes fields, key limits, errors, losses, verified evidence, and invocation examples. Use describe() or the machine-readable reference for complete schemas. The stability policy defines which parts are contractual.
Machine-readable reference
The operation reference JSON publishes complete input, options, and result schemas plus verified examples and qualification evidence for every operation. The checked Managed API contract is available at /api/v2/openapi.