Outline Wiki icon

Outline Wiki

Interact with the Outline Wiki API — documents, collections, comments, attachments, users, shares

Actions31

Document → Import

AI-generated

Summary

Import a file (such as Markdown, HTML, DOCX, CSV) as a new document into the Outline Wiki system, specifying its destination collection or parent document and optional publishing status.

Inputs

  • Collection ID — UUID of the collection to import the document into. Required unless Parent Document ID is provided.
  • Publish — Boolean indicating whether to immediately publish the document (true) or save it as a draft (false). Defaults to false.
  • Binary Property (required) — Name of the binary property that contains the file to import (e.g., Markdown, HTML, DOCX, CSV).
  • Additional Fields — Optional fields including Parent Document ID (UUID of a parent document to import as a child, required if Collection ID not set) and Filename Override (to specify the filename with extension, defaults to binary metadata filename if not set).

Output shape

a single JSON object representing the imported document as returned by the Outline API

Requires either Collection ID or Parent Document ID to be set; throws an error if neither is provided. Consumes a binary file from the specified binary property, uploading it to import as a new document. The import is performed via a multipart/form-data POST to the Outline API. The response JSON includes details of the newly created document.

Examples

Example 1: Import a Markdown file from binary data property 'data' to a specified collection and publish it immediately

Set Collection ID with UUID, set Publish to true, set Binary Property to 'data', optionally override filename in Additional Fields.

Links

Discussion