Outline Wiki icon

Outline Wiki

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

Actions31

Share → Create

AI-generated

Summary

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

Inputs

  • Document ID (required) — The UUID of the document you want to create the share link for.
  • Additional Fields — Optional settings for the share link, including whether to include child documents of the specified document in the share.

Output shape

a JSON object representing the created share link's details.

Returns the API response as JSON for the created share link, including its identifier and sharing URL.

Examples

Example 1: Create a share link for a document with children included

Set 'Document ID' to the target document's UUID and 'Include Child Documents' to true to share the document along with all its child documents.

Links

Discussion