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 document file (e.g., Markdown, HTML, DOCX, CSV) into an Outline Wiki collection or as a child of an existing document, optionally publishing it immediately.

Inputs

  • Collection ID — UUID of the collection to import the document into. Required unless Parent Document ID is set.
  • Publish — Boolean to decide whether to immediately publish (true) or save as draft (false). Defaults to false.
  • Binary Property (required) — Name of the binary property containing the file to import.
  • Parent Document ID — UUID of a parent document to import as a child of. Required unless Collection ID is set.
  • Filename Override — Override filename (with extension). Uses binary metadata filename if not set.

Output shape

a single object representing the imported document response from Outline API

Throws error if neither Collection ID nor Parent Document ID is provided or if the binary data in the specified property is missing. The binary file's content type is guessed if not set in the binary metadata.

Examples

Example 1: Import a Markdown file from binary data named 'data' into a specific collection, publishing immediately

Set Collection ID with the target collection UUID, set Binary Property to 'data', set Publish to true.

Example 2: Import an HTML file as a child of an existing document without publishing

Set Parent Document ID with the target parent document UUID, set Binary Property to the binary file property name.

Links

Discussion