xlsx.convert | Runstamp Docs

Export a workbook to the requested target form.

Use describe("xlsx.convert") when your code needs the complete live JSON Schemas.

At a glance

Property	Value
Package	`@runstamp/xlsx`
Domain / verb	`xlsx` / `convert`
Customer jobs	convert, transform
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/xlsx/convert. 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	`workbookBase64`	`artifactId`
Options	none	`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
`$.workbookBase64`	`minLength=8` `maxLength=89478488`
`$.artifactId`	`minLength=1` `maxLength=256`
`$.timeoutMs`	`minimum=1` `maximum=600000`
`$.limits.maxInputBytes`	`minimum=1` `maximum=67108864`
`$.limits.maxOutputBytes`	`minimum=1` `maximum=134217728`
`$.limits.maxPages`	`minimum=1` `maximum=1048576`
`$.limits.maxElements`	`minimum=1` `maximum=1000000`
`$.limits.maxArchiveEntries`	`minimum=1` `maximum=2000`
`$.limits.maxExpansionRatio`	`minimum=1` `maximum=1000`
`$.limits.maxDurationMs`	`exclusiveMinimum=0` `maximum=600000`

Invoke

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

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

Errors and losses

Declared errors (18)

xlsx/INVALID_INPUT
xlsx/RESOURCE_LIMIT
xlsx/TIMEOUT
xlsx/XLSX_ABORTED
xlsx/XLSX_ARCHIVE_UNSAFE
xlsx/XLSX_BUDGET_EXCEEDED
xlsx/XLSX_CELL_NOT_FOUND
xlsx/XLSX_ENCRYPTED_UNSUPPORTED
xlsx/XLSX_FORMULA_INJECTION
xlsx/XLSX_MAPPING_UNRESOLVED
xlsx/SCHEMA_REJECTED
common/SCHEMA_REJECTED
common/OPERATION_CANCELLED
common/OPERATION_TIMEOUT
common/CONTRACT_VIOLATION
common/RESOURCE_LIMIT_EXCEEDED
common/INPUT_CORRUPT
xlsx/LOSS_POLICY_VIOLATED

Declared losses (1)

xlsx/XLSX_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 (Workbook rendered from the compliance-remediation source).
Example input — SHA-256 8324f102232469b1986041c9763c8a8409f189ea0de1283ce776d8aba3bc6b4d.
Example result — SHA-256 85c5e23be1f5357f23f3350aa15d9e3dd17d71c62acab01b639c53192d492c64.
Verified result SHA-256: 05c817cec9d1c6873eee74c100de9dad77a45061256fba5f767bc615c7e0e14d.
Qualification lane: 11-pdf-xlsx.

Contract fingerprints

Descriptor: 63f32f2c328f324c24ec993af9d9f7b1728260f71a071d6f9ae0297649cef32a.
Input schema: 7da4a0293f6df103436a55cd2ff67821b0edfef421794547be2aa196a398cbd8.
Options schema: 270bc192b082d67454d7cbb48a246232a1b2b2c37dc87090c704d05f0573e8f1.
Result value schema: 07b01726e02c903b9b8edc32691e90ce013fd2879778ea42805d53b7fc4e460d.

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

Export a workbook to the requested target form.

Use describe("xlsx.convert") when your code needs the complete live JSON Schemas.

At a glance

Property	Value
Package	`@runstamp/xlsx`
Domain / verb	`xlsx` / `convert`
Customer jobs	convert, transform
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/xlsx/convert. 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	`workbookBase64`	`artifactId`
Options	none	`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
`$.workbookBase64`	`minLength=8` `maxLength=89478488`
`$.artifactId`	`minLength=1` `maxLength=256`
`$.timeoutMs`	`minimum=1` `maximum=600000`
`$.limits.maxInputBytes`	`minimum=1` `maximum=67108864`
`$.limits.maxOutputBytes`	`minimum=1` `maximum=134217728`
`$.limits.maxPages`	`minimum=1` `maximum=1048576`
`$.limits.maxElements`	`minimum=1` `maximum=1000000`
`$.limits.maxArchiveEntries`	`minimum=1` `maximum=2000`
`$.limits.maxExpansionRatio`	`minimum=1` `maximum=1000`
`$.limits.maxDurationMs`	`exclusiveMinimum=0` `maximum=600000`

Invoke

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

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

Errors and losses

Declared errors (18)

xlsx/INVALID_INPUT
xlsx/RESOURCE_LIMIT
xlsx/TIMEOUT
xlsx/XLSX_ABORTED
xlsx/XLSX_ARCHIVE_UNSAFE
xlsx/XLSX_BUDGET_EXCEEDED
xlsx/XLSX_CELL_NOT_FOUND
xlsx/XLSX_ENCRYPTED_UNSUPPORTED
xlsx/XLSX_FORMULA_INJECTION
xlsx/XLSX_MAPPING_UNRESOLVED
xlsx/SCHEMA_REJECTED
common/SCHEMA_REJECTED
common/OPERATION_CANCELLED
common/OPERATION_TIMEOUT
common/CONTRACT_VIOLATION
common/RESOURCE_LIMIT_EXCEEDED
common/INPUT_CORRUPT
xlsx/LOSS_POLICY_VIOLATED

Declared losses (1)

xlsx/XLSX_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 (Workbook rendered from the compliance-remediation source).
Example input — SHA-256 8324f102232469b1986041c9763c8a8409f189ea0de1283ce776d8aba3bc6b4d.
Example result — SHA-256 85c5e23be1f5357f23f3350aa15d9e3dd17d71c62acab01b639c53192d492c64.
Verified result SHA-256: 05c817cec9d1c6873eee74c100de9dad77a45061256fba5f767bc615c7e0e14d.
Qualification lane: 11-pdf-xlsx.

Contract fingerprints

Descriptor: 63f32f2c328f324c24ec993af9d9f7b1728260f71a071d6f9ae0297649cef32a.
Input schema: 7da4a0293f6df103436a55cd2ff67821b0edfef421794547be2aa196a398cbd8.
Options schema: 270bc192b082d67454d7cbb48a246232a1b2b2c37dc87090c704d05f0573e8f1.
Result value schema: 07b01726e02c903b9b8edc32691e90ce013fd2879778ea42805d53b7fc4e460d.

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