documents

Call documents.generate_document

Changed on

Make a Word document — 'write this up as a doc', 'put it in a Word file', 'I need this as a document I can send'. Create a Word document (.docx) from an ordered list of headings, paragraphs and bullet lists, and save it to this workspace's library. 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 PDF report — that is documents.generate_pdf.

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_document

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/documents.generate_document
  • 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.

titlestring required

The document's title, written as its first heading.

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

    • breaking

      removed subschema #1 subschema #2 subschema #3 from the / request property oneOf list

    • info

      added subschema #1 subschema #2 subschema #3 to the / request property oneOf list