Create Spreadsheet Workbook
spreadsheet.create_workbook
Overview
You pass exactly one of inline sheets or a TABLE_INTERCHANGE_V1 tablesFileRef, and we write one XLSX workbook. Cell types, sheet names, styles and layout follow what you send or the published defaults. Live formulas, macros and request-derived timestamps are never written. The workbook bytes are returned only as a managed file_ref. Workbook rows cost 1 execution credit per 1000 rows, rounded up, minimum 1. Each sheet may name at most 200,000 rows, and the workbook reservation is clamped at 1000 credits.
Extracted tables currently stop at NDJSON or CSV. We add the missing terminal step that produces a managed XLSX workbook you can pass downstream.
Reliability
Identical admitted input and a fixed engine profile produce byte-stable packages. Numbers that cannot round-trip 15 significant digits are refused by default. Caller-visible failures: SPREADSHEET_SHEET_NAME_DUPLICATE — Two sheet names collide case-insensitively.; SPREADSHEET_DATE_OUT_OF_RANGE — A date falls outside the representable Excel serial range.; SPREADSHEET_INPUT_SOURCE_CONFLICT — Exactly one of sheets or tablesFileRef is required.; SPREADSHEET_CELL_INVALID — A cell or workbook option is not in the published closed vocabulary.; DOCUMENT_WORKER_BUSY — Document processing capacity is temporarily full.; SPREADSHEET_NUMBER_FORMAT_UNSUPPORTED — A number format is outside the closed vocabulary.; SPREADSHEET_COLUMN_WIDTH_MISSING — EXPLICIT column width policy requires widthChars on every column.; SPREADSHEET_OUTPUT_TOO_LARGE — The generated workbook exceeds the published output-size limit.; DOCUMENT_WORKER_UNAVAILABLE — The document worker is temporarily unavailable.; SPREADSHEET_MERGED_RANGE_INVALID — A merged range is out of bounds, inverted or overlapping.; DOCUMENT_STORAGE_FAILED — The generated workbook could not be published to managed storage.; SPREADSHEET_LIMIT_EXCEEDED — A named structural workbook dimension exceeded its published cap.; SPREADSHEET_TABLE_SOURCE_INVALID — The table interchange artifact is malformed, truncated or not TABLE_INTERCHANGE_V1.; SPREADSHEET_SHEET_NAME_INVALID — A sheet name breaks a published naming rule.; SPREADSHEET_PROJECTED_WORK_EXCEEDED — Projected cell, string and merge work exceeded the published budget.; SPREADSHEET_STRING_INVALID — A string carries a character the workbook format forbids.; SPREADSHEET_ROW_SHAPE_INVALID — A row length contradicts the declared column count or row-shape policy.; DOCUMENT_TIMEOUT — The document worker is temporarily unavailable.; SPREADSHEET_EXECUTION_FAILED — Workbook generation failed an integrity or contract check.; SPREADSHEET_NUMBER_PRECISION_EXCEEDED — A numeric value cannot round-trip through a 15-digit binary64 cell.; SPREADSHEET_CELL_TYPE_UNSUPPORTED — A FORMULA or ERROR cell arrived under a REJECT policy.; SPREADSHEET_DATE_ZONE_UNSUPPORTED — A date carried a zone or offset, which an XLSX serial cannot store.; SPREADSHEET_AUTOFILTER_WITHOUT_HEADER — autoFilter requires headerRow true.
Context footprint
Returns one managed file_ref plus sheet receipts; never workbook bytes. Workbook rows cost 1 execution credit per 1000 rows, rounded up, minimum 1. Each sheet may name at most 200,000 rows, and the workbook reservation is clamped at 1000 credits. Inline sheets name those rows, so we reserve from the summed row arrays until settlement reports the rows actually written. A tablesFileRef does not name row count, so we reserve that ceiling.
When to use it
Use when you already have normalized cells and need one XLSX file_ref.
Avoid when the caller needs macros, live formulas, a template or CSV.
Apache POI 5.5.1 SXSSF in the attested document-analysis worker
Scope
Non-goals
- Does not evaluate formulas or emit live <f> cells
- Does not create XLSM, XLS, ODS or CSV
- Does not infer types, headers, units or column widths from content
- Does not read a caller-supplied template
Properties
Capabilities
Cost & billing
1 execution credit per 1000 workbook rows, rounded up, reserved from the request and capped at 12800000 rows (1000 credits).
File handling
File limits
Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.
| Limit | Value | Limited by |
|---|---|---|
| Maximum size per input file | 50 MiB | Skill and platform maximum |
| Maximum total input size | 50 MiB | Skill maximum |
| Maximum number of input files | 1 | Skill maximum |
| Maximum generated artifact size | 50 MiB | Skill maximum |
| Maximum number of generated files | 1 | Skill maximum |
| Maximum total generated size | 50 MiB | Skill maximum |
How we handle your data
What this means
This skill may temporarily store files or intermediate data only to complete execution. Temporary data is protected and automatically deleted.
Squillify guarantees
- Runs inside Squillify using a contained third-party component
- This skill runs inside Squillify.
- Payloads are not sent to an external service by this skill.
- Contained third party component
- Temporary execution only storage
- Squillify does not permanently store submitted payloads.
- Telemetry records metadata only, not submitted content.
- Submitted payloads are not used for training.
- Submitted payloads are not reviewed by humans.
- This skill does not target sensitive data.
- The response may contain submitted or transformed content.
Your responsibility
Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| sheets | array | No | Optional array of 1 through 64 closed sheet objects with rows and optional columns, names and layout; omit it when you pass tablesFileRef. |
| tablesFileRef | string | No | Optional tenant-owned TABLE_INTERCHANGE_V1 NDJSON file_ref, at most 50 MiB; omit it when you pass sheets. |
| options | object | No | Optional closed workbook policies including filename, styleProfile, columnWidthPolicy, formulaPolicy, errorPolicy, numberPrecisionPolicy, rowShapePolicy, textLeadingCharacterPolicy and dateSystem; omit it to apply the published defaults. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| output | object | Yes | Published workbook object with fileRef, filename, mediaType, sizeBytes, sha256 and expiresAt; never inline bytes. |
| workbook | object | Yes | Workbook receipt with per-sheet objects plus sheetCount, cellCount and distinctStringCount; never cell values. |
| applied | object | Yes | Policies actually applied, including styleProfile, inputSource, filename and the closed formula, error, precision, row-shape and date policies. |
| engine | object | Yes | Closed document-analysis worker identity bound to Apache POI 5.5.1 and spreadsheet-writer-v1. |
| warnings | array | Yes | Array of 0 through 64 warning objects with code, count and sheetIndex; never includes cell values. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"spreadsheet.create_workbook","input":{"sheets":[{"name":"Revenue","headerRow":true,"rows":[["Month","Amount"],["January",12.5]]}]}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("spreadsheet.create_workbook", {"sheets":[{"name":"Revenue","headerRow":true,"rows":[["Month","Amount"],["January",12.5]]}]});Errors
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
| SPREADSHEET_SHEET_NAME_DUPLICATE | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_DATE_OUT_OF_RANGE | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_INPUT_SOURCE_CONFLICT | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_CELL_INVALID | 400 | No | The request payload failed this skill's input validation. |
| DOCUMENT_WORKER_BUSY | 503 | Yes | A dependency required by this skill is unavailable. |
| SPREADSHEET_NUMBER_FORMAT_UNSUPPORTED | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_COLUMN_WIDTH_MISSING | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_OUTPUT_TOO_LARGE | 429 | No | A size, quota, rate, or time limit was exceeded. |
| DOCUMENT_WORKER_UNAVAILABLE | 503 | Yes | A dependency required by this skill is unavailable. |
| SPREADSHEET_MERGED_RANGE_INVALID | 400 | No | The request payload failed this skill's input validation. |
| DOCUMENT_STORAGE_FAILED | 503 | Yes | A dependency required by this skill is unavailable. |
| SPREADSHEET_LIMIT_EXCEEDED | 429 | No | A size, quota, rate, or time limit was exceeded. |
| SPREADSHEET_TABLE_SOURCE_INVALID | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_SHEET_NAME_INVALID | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_PROJECTED_WORK_EXCEEDED | 429 | No | A size, quota, rate, or time limit was exceeded. |
| SPREADSHEET_STRING_INVALID | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_ROW_SHAPE_INVALID | 400 | No | The request payload failed this skill's input validation. |
| DOCUMENT_TIMEOUT | 503 | Yes | A dependency required by this skill is unavailable. |
| SPREADSHEET_EXECUTION_FAILED | 500 | No | The skill encountered an unexpected execution failure. |
| SPREADSHEET_NUMBER_PRECISION_EXCEEDED | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_CELL_TYPE_UNSUPPORTED | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_DATE_ZONE_UNSUPPORTED | 400 | No | The request payload failed this skill's input validation. |
| SPREADSHEET_AUTOFILTER_WITHOUT_HEADER | 400 | No | The request payload failed this skill's input validation. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not evaluate formulas or emit live <f> cells
- Does not create XLSM, XLS, ODS or CSV
- Does not infer types, headers, units or column widths from content
- Does not read a caller-supplied template
- Macro-enabled workbooks
- Filling an existing template
- Returning workbook bytes inline
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "spreadsheet.create_workbook",
"input": {
"sheets": [
{
"name": "Revenue",
"headerRow": true,
"rows": [
[
"Month",
"Amount"
],
[
"January",
12.5
]
]
}
]
}
}Examples
Write one typed sheet to a managed workbook
{
"sheets": [
{
"name": "Revenue",
"headerRow": true,
"rows": [
[
"Month",
"Amount"
],
[
"January",
12.5
]
]
}
]
}{
"warnings": [],
"applied": {
"textLeadingCharacterPolicy": "PRESERVE",
"numberPrecisionPolicy": "REJECT",
"styleProfile": "PLAIN",
"rowShapePolicy": "STRICT",
"errorPolicy": "STORE_AS_TEXT",
"dateSystem": "DATE_1900",
"formulaPolicy": "REJECT",
"columnWidthPolicy": "DEFAULT",
"filename": "workbook.xlsx",
"inputSource": "INLINE"
},
"workbook": {
"sheets": [
{
"cellCount": 4,
"mergedRangeCount": 0,
"rowCount": 2,
"columnCount": 2,
"frozenColumns": 0,
"frozenRows": 0,
"index": 1,
"name": "Revenue",
"autoFilter": false,
"headerRow": true
}
],
"cellCount": 4,
"sheetCount": 1,
"distinctStringCount": 3
},
"output": {
"fileRef": "squillify://files/f-generated-workbook",
"filename": "workbook.xlsx",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"expiresAt": "2026-08-14T00:00:00Z",
"sizeBytes": 4096
},
"engine": {
"poiVersion": "5.5.1",
"deterministic": true,
"writerProfileRevision": "spreadsheet-writer-v1",
"imageDigest": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"engines": {
"Apache PDFBox": "3.0.8",
"Apache POI": "5.5.1"
},
"manifestDigest": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"adapterId": "document-analysis",
"adapterRevision": "pdf-v1",
"profileRevision": "pdf-v1"
}
}Write a workbook from a table interchange file
{
"tablesFileRef": "squillify://files/f-tables"
}{
"warnings": [],
"applied": {
"textLeadingCharacterPolicy": "PRESERVE",
"numberPrecisionPolicy": "REJECT",
"styleProfile": "PLAIN",
"rowShapePolicy": "STRICT",
"errorPolicy": "STORE_AS_TEXT",
"dateSystem": "DATE_1900",
"formulaPolicy": "REJECT",
"columnWidthPolicy": "DEFAULT",
"filename": "workbook.xlsx",
"inputSource": "TABLES_FILE"
},
"workbook": {
"sheets": [
{
"cellCount": 4,
"mergedRangeCount": 0,
"rowCount": 2,
"columnCount": 2,
"frozenColumns": 0,
"frozenRows": 0,
"index": 1,
"name": "Sheet1",
"autoFilter": false,
"headerRow": true
}
],
"cellCount": 4,
"sheetCount": 1,
"distinctStringCount": 3
},
"output": {
"fileRef": "squillify://files/f-generated-workbook",
"filename": "workbook.xlsx",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"expiresAt": "2026-08-14T00:00:00Z",
"sizeBytes": 4096
},
"engine": {
"poiVersion": "5.5.1",
"deterministic": true,
"writerProfileRevision": "spreadsheet-writer-v1",
"imageDigest": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"engines": {
"Apache PDFBox": "3.0.8",
"Apache POI": "5.5.1"
},
"manifestDigest": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"adapterId": "document-analysis",
"adapterRevision": "pdf-v1",
"profileRevision": "pdf-v1"
}
}Recommended use cases
- Turn pdf.extract_tables FILE_REF artifacts into an Excel workbook
- Write a small typed grid as a managed XLSX file
Avoid for
- Macro-enabled workbooks
- Filling an existing template
- Returning workbook bytes inline
Related skills
Composable with
Safety & privacy
- Runs without calling any external service.
- Your payloads are never stored permanently.
- Telemetry captures metadata only — never your payload contents.
- We never train models on your payloads.
- No human reviews your payloads.