Joplin Api

v0.1.3

Manage Joplin notes via REST API. Use for creating, reading, updating, deleting, or searching Joplin notes programmatically.

3· 669· 7 versions· 1 current· 1 all-time· Updated 10h ago· MIT-0
byKGTAF@killgfat

Install

openclaw skills install joplin-api

Joplin API Skill

Manage Joplin notes, notebooks, and tags via Joplin Data API.


Environment Variables

VariableRequiredDefaultDescription
JOPLIN_BASE_URLNohttp://localhost:41184Joplin API URL
JOPLIN_TOKENYes-API Token from Web Clipper

Quick Start

1. Get API Token

  1. Open Joplin → ToolsOptionsWeb Clipper
  2. Enable service and copy the token

2. Test Connection

python3 joplin.py ping

Basic Commands

python3 joplin.py ping                    # Test connection
python3 joplin.py create --title "Title"  # Create note
python3 joplin.py search "keyword"        # Search
python3 joplin.py list --type notes       # List notes
python3 joplin.py stats                   # Statistics

Security

  • Import/Export restricted to workspace directory
  • Sensitive system directories blocked

Documentation

  • references/API.md - Full API reference
  • references/CONFIGURATION.md - Configuration examples

Version tags

apivk971j9z8840npcbbmngjms48c5824e1yjoplinvk971j9z8840npcbbmngjms48c5824e1ylatestvk971j9z8840npcbbmngjms48c5824e1ynotesvk971j9z8840npcbbmngjms48c5824e1yproductivityvk971j9z8840npcbbmngjms48c5824e1yrestvk971j9z8840npcbbmngjms48c5824e1y

Runtime requirements

Binspython3
Environment variables
JOPLIN_BASE_URLoptionalJoplin Data API base URL
JOPLIN_TOKENrequiredAPI Token from Joplin Web Clipper settings
JOPLIN_IMPORT_DIRoptionalAllowed directory for import operations
JOPLIN_EXPORT_DIRoptionalAllowed directory for export operations