documents

Call documents.generate_pdf

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.

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

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Request body

namestring required

The artifact's BASE name, with no file extension — the engine appends the one that matches what it actually wrote.

htmlstring 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.

pageSize'a4' | 'letter'

Defaults to a4.

orientation'portrait' | 'landscape'

Defaults to portrait.

workspacestring

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

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.

OR

Changes

No recorded changes to this operation across all 4 revisions of this API.