Apply an edit list to a Word file as tracked changes and comments; the redline gate refuses any result Word would read differently.
Use describe("docx.transform.redline") when your code needs the complete live JSON Schemas.
At a glance
| Property | Value |
|---|---|
| Package | @runstamp/registry |
| Domain / verb | docx / transform |
| Customer jobs | transform |
| Deterministic | No |
| Side effects | none |
Availability
| Local | SDK | CLI | MCP | Managed API |
|---|---|---|---|---|
| unavailable | unavailable | unavailable | unavailable | public ga |
Managed API route: POST /api/v2/operations/docx/transform/redline. 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 | none | none |
| Options | editList | operation, author, date, deterministic, deterministicSeed, timeoutMs, locale, lossPolicy, limits |
| Result value | artifact, revisions, comments, authors, summary | 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 |
|---|---|
$.author | minLength=1maxLength=256 |
$.timeoutMs | minimum=1 |
Invoke
const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/docx/docx.transform.redline/input.json").then((response) => response.json());
const result = await runstamp.run("docx.transform.redline", 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/docx/docx.transform.redline/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke docx.transform.redline --input input.json{
"tool": "runstamp_invoke_operation",
"arguments": {
"operation": "docx.transform.redline",
"input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/docx/docx.transform.redline/input.json>",
"execution_mode": "local"
}
}Errors and losses
Declared errors (9)
common/SCHEMA_REJECTEDcommon/CONTRACT_VIOLATIONcommon/OPERATION_CANCELLEDcommon/OPERATION_TIMEOUTcommon/RESOURCE_LIMIT_EXCEEDEDcommon/INPUT_CORRUPTcommon/STEP_REJECTEDcommon/POLICY_DENIEDcommon/INVARIANT_VIOLATED
Declared losses (0)
- None.
SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.
Verified example and exact contract
- Fixture:
icp-workflow(Statement of work SOW-3 go-live reschedule). - Example input — SHA-256
f451c4be8959e76cdb389f5236ba2c110d8fe0764550249327c3c8c5b9db9319. - Example result — SHA-256
85c264876dde748c3706cab7f903692eb618e7b2bae6572fe16a019604e51f03. - Verified result SHA-256:
63f5ab94bc93a1d777158372d94f9a9a6bd08c419975d601c27726b5960c92b6. - Qualification lane:
10-pptx-docx.
Contract fingerprints
- Descriptor:
6dca84dc76457fefcb11899445731baf15e3b5e8c6a35662133409b82772b272. - Input schema:
c32b7686583b9cf4074b43a640fa8cce771772b13e76b490346a91d4077f5808. - Options schema:
297e61675cfd110994bc71ffa090c5883725ae23f20515da202c54fccf63134c. - Result value schema:
781d0689e13a6d01ed3c6a7477a9464cba2868ffd3a05b5ac00558e9b6991ad8.
The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.