docx.inspect.controlled | Runstamp Docs

Inspect a controlled Word document's parts and relationships.

Use describe("docx.inspect.controlled") when your code needs the complete live JSON Schemas.

At a glance

Property	Value
Package	`@runstamp/docx`
Domain / verb	`docx` / `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/docx/inspect/controlled. 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	`artifactBase64`	none
Options	none	`deterministic`, `deterministicSeed`, `timeoutMs`, `locale`, `lossPolicy`, `limits`, `operation`
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
`$.artifactBase64`	`minLength=4` `pattern="^[A-Za-z0-9+/=\\s]+$"`
`$.timeoutMs`	`minimum=1`
`$.limits.maxInputBytes`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxOutputBytes`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxPages`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxElements`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxArchiveEntries`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxExpansionRatio`	`minimum=1`
`$.limits.maxDurationMs`	`exclusiveMinimum=0` `maximum=2147483647`

Invoke

const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/docx/docx.inspect.controlled/input.json").then((response) => response.json());
const result = await runstamp.run("docx.inspect.controlled", 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.inspect.controlled/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke docx.inspect.controlled --input input.json

{
  "tool": "runstamp_invoke_operation",
  "arguments": {
    "operation": "docx.inspect.controlled",
    "input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/docx/docx.inspect.controlled/input.json>",
    "execution_mode": "local"
  }
}

Errors and losses

Declared errors (18)

docx/INVALID_INPUT
docx/RESOURCE_LIMIT
docx/TIMEOUT
docx/DOCX_INVALID_PACKAGE
docx/DOCX_ENCRYPTED_INPUT
docx/DOCX_ARCHIVE_LIMIT
docx/DOCX_UNSAFE_ARCHIVE_PATH
docx/DOCX_XML_LIMIT
docx/DOCX_INVALID_LOCATOR
docx/DOCX_STALE_LOCATOR
docx/DOCX_PRESERVATION_NOT_VERIFIED
docx/DOCX_OPERATION_FAILED
docx/SCHEMA_REJECTED
common/SCHEMA_REJECTED
common/OPERATION_CANCELLED
common/OPERATION_TIMEOUT
common/CONTRACT_VIOLATION
docx/LOSS_POLICY_VIOLATED

Declared losses (1)

docx/DOCX_OPAQUE_PART_PRESERVED

SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.

Verified example and exact contract

Fixture: icp-workflow (Rendered Q2 business review).
Example input — SHA-256 1f366cb00cdbaa58dbbc72cb2afa97abe376119e34d9784a71c2208f55cba8a6.
Example result — SHA-256 da691b9a4f392f7d57dea68c68512084f5d7e26252529e8f87e2358a7e53e298.
Verified result SHA-256: 9a3c9b9006f7cc80b08e54157b0b2f12caaf2e7391f72b578cf53180c25e7453.
Qualification lane: 10-pptx-docx.

Contract fingerprints

Descriptor: d861da92dbf7392d2336530795fdd991fc6696a9ea826cf38c7b76dbb0ee8f7d.
Input schema: ab2eea4b1d27167ed1a11b2d2b6b7bc449bfde85dcb72bef69b20b49e3c0e7c0.
Options schema: a9d46a4ac093bca1bdbff962f04e018d7180406995c030b59ce2cb328bf9dee7.
Result value schema: e9a57013cfdbe016febf52a87fde5af6ad8a4de2b77574b7cdfb333d31261ca1.

The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.

Inspect a controlled Word document's parts and relationships.

Use describe("docx.inspect.controlled") when your code needs the complete live JSON Schemas.

At a glance

Property	Value
Package	`@runstamp/docx`
Domain / verb	`docx` / `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

Input and result

Schema	Required fields	Optional fields
Input	`artifactBase64`	none
Options	none	`deterministic`, `deterministicSeed`, `timeoutMs`, `locale`, `lossPolicy`, `limits`, `operation`
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
`$.artifactBase64`	`minLength=4` `pattern="^[A-Za-z0-9+/=\\s]+$"`
`$.timeoutMs`	`minimum=1`
`$.limits.maxInputBytes`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxOutputBytes`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxPages`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxElements`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxArchiveEntries`	`minimum=1` `maximum=9007199254740991`
`$.limits.maxExpansionRatio`	`minimum=1`
`$.limits.maxDurationMs`	`exclusiveMinimum=0` `maximum=2147483647`

Invoke

const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/docx/docx.inspect.controlled/input.json").then((response) => response.json());
const result = await runstamp.run("docx.inspect.controlled", 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.inspect.controlled/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke docx.inspect.controlled --input input.json

{
  "tool": "runstamp_invoke_operation",
  "arguments": {
    "operation": "docx.inspect.controlled",
    "input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/docx/docx.inspect.controlled/input.json>",
    "execution_mode": "local"
  }
}

Errors and losses

Declared errors (18)

docx/INVALID_INPUT
docx/RESOURCE_LIMIT
docx/TIMEOUT
docx/DOCX_INVALID_PACKAGE
docx/DOCX_ENCRYPTED_INPUT
docx/DOCX_ARCHIVE_LIMIT
docx/DOCX_UNSAFE_ARCHIVE_PATH
docx/DOCX_XML_LIMIT
docx/DOCX_INVALID_LOCATOR
docx/DOCX_STALE_LOCATOR
docx/DOCX_PRESERVATION_NOT_VERIFIED
docx/DOCX_OPERATION_FAILED
docx/SCHEMA_REJECTED
common/SCHEMA_REJECTED
common/OPERATION_CANCELLED
common/OPERATION_TIMEOUT
common/CONTRACT_VIOLATION
docx/LOSS_POLICY_VIOLATED

Declared losses (1)

docx/DOCX_OPAQUE_PART_PRESERVED

SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.

Verified example and exact contract

Fixture: icp-workflow (Rendered Q2 business review).
Example input — SHA-256 1f366cb00cdbaa58dbbc72cb2afa97abe376119e34d9784a71c2208f55cba8a6.
Example result — SHA-256 da691b9a4f392f7d57dea68c68512084f5d7e26252529e8f87e2358a7e53e298.
Verified result SHA-256: 9a3c9b9006f7cc80b08e54157b0b2f12caaf2e7391f72b578cf53180c25e7453.
Qualification lane: 10-pptx-docx.

Contract fingerprints

Descriptor: d861da92dbf7392d2336530795fdd991fc6696a9ea826cf38c7b76dbb0ee8f7d.
Input schema: ab2eea4b1d27167ed1a11b2d2b6b7bc449bfde85dcb72bef69b20b49e3c0e7c0.
Options schema: a9d46a4ac093bca1bdbff962f04e018d7180406995c030b59ce2cb328bf9dee7.
Result value schema: e9a57013cfdbe016febf52a87fde5af6ad8a4de2b77574b7cdfb333d31261ca1.

The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.