Skip to main content

Document Render Tool

document_render is a native tool that can render document, slide, or sheet pages through the document renderer.

When To Use It​

Use document_render when a bot or workflow needs this capability inside the current workspace. Prefer this tool over ad hoc text handling when the task depends on workspace artifacts, blobs, links, events, channels, forms, media, or operation state.

Inputs And Outputs​

  • Tool name: document_render.
  • Input contract: DocumentRenderArgs with fields artifact_id, source_slot.
  • Output contract: DocumentRenderOutput with fields state, executor, run_id, note, result, error.

The caller should provide exact workspace, artifact, blob, channel, or operation references from the current context whenever the contract requires them.

Example Task​

A user can ask the selected workspace bot to run this kind of tool-backed work when the needed source context is visible or named. The bot should return a concise result and point to any artifact, blob, event, message, or operation output that was created or inspected.

Limits And Review​

  • Confirm the bot has access to the workspace and relevant artifacts.
  • Check required references before retrying a failed call.
  • Keep results bounded enough for channel delivery and operation review.
  • Review any durable workspace changes this tool creates before treating them as final.

Media To Add​

  • Table: example document_render input fields, output fields, and review action. It helps developers and admins understand the contract without reading raw schemas. Source: a sample operation that uses this tool.