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

# Call documents.generate_pdf

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

## Request

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

Make a PDF report — 'send me this as a PDF', 'turn this into a report', 'I need a PDF of these numbers'.  Create a PDF by printing HTML you write, and save it to this workspace's library. Send the document BODY only — scripts and remote files are refused by the renderer, so the markup must stand on its own. To include a chart, declare it in `charts` and write its `{{chart:…}}` token in the body: that is the only way a figure gets into a report. 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 an editable Word document — that is `documents.generate_document`.

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.
  - `html` string, required: The document BODY as HTML — headings, paragraphs, lists, tables, inline `style` attributes. Do NOT send a whole page: no <html>, <head>, <script>, <link> or <img src="http…">. The renderer wraps your markup in a document whose content policy refuses every script and every remote file, so any of those is silently inert rather than an error. To place a chart, write the token `{{chart:sales}}` where it belongs and declare a matching entry in `charts`.
  - `charts` object[]: Charts to compose INTO this report. This is the only way to put a chart in a PDF: a chart made with `documents.generate_chart` is a separate file and cannot be pulled into a document, because the renderer refuses every remote file. Give each entry a `placeholder` and write `{{chart:<placeholder>}}` in the body where the chart belongs — a declared chart the body never writes, and a token no chart declares, are both REFUSED rather than quietly dropped.
    - `placeholder` string, required: The name used in the body's `{{chart:…}}` token.
    - `chartType` 'bar' | 'line' | 'pie', required
    - `title` string: Optional chart title.
    - `categories` string[], required: The x-axis labels (or the pie's slice labels). Every series must carry exactly one value per category.
    - `series` object[], required: One entry per plotted line/bar-group. A PIE chart takes exactly one series.
      - `name` string, required
      - `values` number[], required
    - `width` integer: Optional pixel width.
    - `height` integer: Optional pixel height.
  - `pageSize` 'a4' | 'letter': Defaults to a4.
  - `orientation` 'portrait' | 'landscape': Defaults to portrait.
  - `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/f9b4aeb83edc?raw)