Tools reference Leave feedback

Tool	What it does
`get_document_info`	Returns the format family, pages (worksheets, slides), protection and the formats it can be saved to
`replace_text`	Finds and replaces text and saves an edited copy, keeping formatting; one worksheet or slide at a time
`extract_html`	Turns a document — or one worksheet, slide or PDF page range — into editable HTML
`save_from_html`	Saves edited HTML as a document, or splices one edited worksheet or slide back into the original
`get_form_fields`	Lists a Word form’s fields with their names, types and current values
`fill_form_fields`	Fills Word form fields by name and saves a filled copy; reports unknown names
`get_supported_formats`	Lists the formats the engine opens and saves, or the save targets for one file
`get_license_status`	Reports the active licensing mode and, under metered licensing, consumption

The FileInput shape

Every tool takes its document through the same file object — pass either a name from your storage folder or inline content:

{ "file": { "filePath": "contract.docx" } }

Field	Type	Description
`filePath`	string	File path or name in the configured storage folder
`fileContent`	string	Base64-encoded file content (alternative to `filePath`)
`fileName`	string	Original filename with extension — required with `fileContent`. Since 26.9.0 it also works on its own, resolved from the storage folder exactly like `filePath`

You rarely write this JSON yourself: the AI agent does, from your plain-language prompt. Missing files are not an error to fear — the tool responds with the list of available files so the agent can correct itself.

We value your opinion. Your feedback will help us improve our documentation.

Tools reference Leave feedback

On this page

The FileInput shape

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!

On this page