Outline icon

Outline

Interact with Outline knowledge base

Overview

This node interacts with the Outline knowledge base API, specifically enabling operations on attachments when the resource is set to "Attachment" and the operation is "Create". It allows users to create new file attachments associated optionally with a document in Outline. This is useful for automating the upload or linking of files such as images, PDFs, or other documents into an Outline knowledge base.

Practical examples include:

  • Automatically attaching generated reports or images to specific documents in Outline.
  • Uploading user-submitted files as attachments to relevant knowledge base entries.
  • Integrating external systems that produce files needing to be stored within Outline.

Properties

Name Meaning
File Name The name of the file to be attached (e.g., "report.pdf").
Content Type The MIME type of the file, indicating its format (e.g., "image/png", "application/pdf").
File Size The size of the file in bytes.

Output

The output JSON contains the response from the Outline API after creating the attachment. This typically includes details about the newly created attachment such as its ID, name, content type, size, and possibly a link or metadata related to the attachment.

No binary data output is handled by this node; it only sends metadata about the attachment creation result.

Dependencies

  • Requires an API key credential for authenticating requests to the Outline API.
  • The node uses an internal helper function to make HTTP POST requests to Outline endpoints.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing incorrect MIME types or file sizes may lead to API rejections.
    • Omitting required fields like File Name, Content Type, or File Size will cause validation errors.
  • Error messages:

    • Authentication errors usually indicate invalid or missing API keys; verify your credential configuration.
    • Validation errors from the API will specify which input property is incorrect or missing.
    • Network or timeout errors suggest connectivity issues; check your network and Outline service status.

Links and References

Discussion