Outline Wiki icon

Outline Wiki

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

Share → Create

AI-generated

Summary

Create a public share link for a specified document in the Outline Wiki, optionally including its child documents.

Inputs

  • Document ID (required) — UUID of the document to share
  • Include Child Documents — Optional boolean to specify whether to include child documents in the share (default is false)

Output shape

a single record containing the API response JSON for the created share link

Returns JSON with the details of the created share link as provided by the Outline API.

Examples

Example 1: Create a share link for a document without child documents

Set Document ID to the target document's UUID; leave Include Child Documents unset or false.

Example 2: Create a share link including child documents

Set Document ID and set Include Child Documents to true in Additional Fields.

Links

Discussion