Outline icon

Outline

Interact with Outline knowledge base

Overview

This node integrates with the Outline knowledge base API, allowing users to perform various operations on different resources such as documents, collections, groups, comments, attachments, and more. Specifically for the Document resource and the Templatize operation, the node creates a template from an existing document in the Outline system.

This is useful when you want to reuse the structure or content of a document as a template for creating new documents, enabling consistent formatting and content reuse across your knowledge base.

Practical example:
You have a standard project report document in Outline that you want to use as a starting point for multiple projects. Using this node's "Templatize" operation, you can convert that document into a template, which can then be used to quickly create new project reports with the same layout and sections.

Properties

Name Meaning
Document ID The unique identifier of the document you want to templatize (create a template from).

Output

The output contains the JSON response from the Outline API after creating a template from the specified document. This typically includes details about the newly created template document, such as its ID, title, and other metadata.

The output is structured as:

{
  "json": {
    // Template document details returned by the Outline API
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Outline API.
  • Requires an API key credential configured in n8n to authenticate requests to the Outline service.
  • The node uses the Outline API endpoints via POST requests to perform actions.

Troubleshooting

  • Common issues:

    • Invalid or missing Document ID: Ensure the Document ID provided exists and is correct.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or API downtime: Check connectivity and Outline service status.
  • Error messages:

    • Errors returned from the Outline API will be passed through. For example, if the document does not exist, an error message indicating "document not found" may appear.
    • If the node is set to continue on fail, errors will be included in the output JSON under an error field.
  • Resolution tips:

    • Double-check input parameters.
    • Confirm API credentials and permissions.
    • Review Outline API documentation for specific error codes.

Links and References

Discussion