Load Joplin Notes into Your Application

Joplin (Markdown) Loader is a LlamaIndex integration that connects to the Joplin note-taking app's local database through its REST API. It retrieves all notes and their associated metadata. The loader requires an access token from Joplin's Web Clipper service to authenticate and extract content while the Joplin app remains open.

Use this loader when you need to retrieve notes from an active Joplin database while maintaining a live connection to the app.

Do NOT use this loader if you need a one-time export or if keeping the Joplin app open during loading is impractical. In those cases, export Joplin notes to Markdown files with Front Matter metadata and use a Markdown reader like ObsidianReader instead.

You provide an access token obtained from Joplin's Web Clipper settings (either directly to the reader or via the JOPLIN_ACCESS_TOKEN environment variable). The Joplin app must remain open during the loading process.

You receive a list of documents.

This loader integrates with:

• Joplin: An open source note-taking app that stores notes locally. The loader connects via Joplin's REST API to access the local database.
• LlamaIndex: The loader returns documents in LlamaIndex format.

Install the package:

pip install llama-index-readers-joplin

Basic usage example:

import os

from llama_index.readers.joplin import JoplinReader

documents = JoplinReader(
    access_token="<access_token>"
).load_data()  # Returns list of documents

This loader is for users who want to retrieve notes from Joplin via its REST API. Users who prefer static exports or don't need live database access should consider the Markdown export alternative mentioned in the source material.