Tools reference/Documents

Documents tools.

Documents are written in Stable Baseline's document markup, a superset of Markdown with diagrams, images, charts and panels; `getCdmdLanguageGuide` explains it. `editDocument` applies small patches and refuses to overwrite a newer version, `findAndReplaceTextInDocument` makes a change across a document in one go, and `listDocumentVersions` lists versions with who made them.

The live list

Your AI tool can call searchTools with category: "documents" for the current list of these tools with every input. This page is the readable copy.

The tools

Every tool below keeps to the access of the key or sign-in that calls it, and to the person’s own role. A tool only sees the tools it may use.

  • createDocument

    Create a new document. Followed by diagram/image inserts.

  • createDocumentFromUpload

    Turn an uploaded file (Word, PDF and more) into a Stable Baseline document.

  • createDocumentIngestSession

    Get an upload session for a document conversion.

  • deleteDocument

    Soft-delete a document.

  • editDocument

    Apply a line-based patch with optimistic locking. Also moves/repositions a single document via folderId/position.

  • exportDocument

    Export a Stable Baseline document as a PDF or an editable Word document (docx), styled with the organisation's brand, or with an export template when templateId is given.

  • findAndReplaceTextInDocument

    Targeted string replacement across the document body.

  • getCdmdLanguageGuide

    Full CDMD block reference (markdown superset for Stable Baseline).

  • getDocument

    Read a document by ID (returns CDMD content + version timestamp).

  • getDocumentIngestJob

    Poll the status of an ingest job.

  • listDocuments

    List documents in a folder or project.

  • listDocumentVersions

    Version history with authors, summaries, and timestamps.

  • reorderDocuments

    Move documents between folders and reorder them, in one batch call. Filing only: no new version of the documents.