Save a document
tp_save_documentSaves a new document to the user's TransformPipe account and returns its id, size and, when shared, its URL. Use it when the user asks to save, keep or store content, or to publish it as a link. The source is Markdown, or HTML, CSV, TSV, JSON, plain text, RTF or ENEX named in from, converted on save. folder saves it into a folder by id or path and creates missing folders on the path. share sets who can open it: "private" (default), "link" (anyone with the URL) or "people" (the addresses in emails, who are emailed a link). A share of "link" or "people", or a folder that is shared or inside a shared folder, requires confirm: true; without it nothing is saved and the response describes what would be disclosed. replaces records the new document as the next version of an earlier one. Each call creates a new document; to change the text of an existing document, call tp_update_document.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"markdown": "<markdown>"
},
"name": "tp_save_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | Source format to convert on save. Omit for Markdown. Binary files (.docx, .xlsx, .pptx, .epub, .odt, export .zip) cannot be passed as tool arguments. | |
| name | No | File name. Default "document.md"; converted content is stored as .md. | |
| share | No | Who can open it: private (default), link or people. | |
| emails | No | Reader addresses when `share` is "people". | |
| folder | No | Folder to save into: an id from tp_list_folders, or a path from the top such as "Devart AI/Home" (`/` or `›` between names, case-insensitive). Missing folders on the path are created. Omit to save outside any folder. | |
| confirm | No | Required when `share` is "link" or "people", or when `folder` is shared or inside a shared folder. Set true after the user has agreed to that audience. | |
| markdown | Yes | The content to save: Markdown, or the format named in `from`. | |
| replaces | No | Id of an earlier document; the new document is recorded as its next version, with its own id and link. tp_list_documents returns ids. |