---
title: "Call documents.generate_spreadsheet"
method: POST
path: "/api/v1/tools/documents.generate_spreadsheet"
tags: ["documents"]
---

# Call documents.generate_spreadsheet

`POST /api/v1/tools/documents.generate_spreadsheet`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/documents.generate_spreadsheet`
- Auth: HTTP bearer

Make a spreadsheet — 'put this in a spreadsheet', 'give me an Excel file of that', 'export these as a CSV I can open'.  Create a spreadsheet — an .xlsx workbook or a single-sheet CSV — from data you already have, and save it to this workspace's library. Declare the columns, then give the rows as objects keyed by those columns. On success: tell the operator the file is saved to their library, name it, and give them the download link — say the link is temporary while the file itself stays in the library. Never paste the file's contents back into the conversation. If the result carries `warnings`, the file WAS made but something in it needs saying — read each warning out before you offer the link, and offer to fix what it names. Not for a Data table that lives on a board — that is `data.create_table`.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `name` string, required: The artifact's BASE name, with no file extension — the engine appends the one that matches what it actually wrote.
  - `format` 'xlsx' | 'csv', required: `xlsx` for a real workbook (multiple tabs, column widths). `csv` for plain data — CSV is a SINGLE-SHEET format, so a csv request carrying more than one sheet is refused rather than silently truncated.
  - `sheets` object[], required: One entry per tab. Declare the columns first, then give each row as an object keyed by those column keys — a row key with no matching column is REFUSED, never dropped, so the export can never be quietly incomplete.
    - `name` string, required: The tab name.
    - `columns` object[], required: The columns, in the order they should appear.
      - `key` string, required: The key each row object uses for this column.
      - `header` string, required: The header text written in row 1.
      - `width` integer: Optional column width in Excel character units. Ignored by CSV.
    - `rows` object[], required: The data rows, each an object keyed by column key. Values are text, numbers, true/false or null — a DATE is passed as the text you want the reader to see, because a date's format and timezone differ between xlsx and CSV and guessing either would change what the sheet says.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `storage_object_id` string, uuid, required
    - `filename` string, required
    - `content_type` string, required
    - `byte_length` integer, required
    - `render_path` string, required
    - `download_url` string, required
    - `warnings` object[]
      - `code` string, required
      - `message` string, required
      - `context` object
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/bd8f793b36b5?raw)