通过 REST API 管理 Joplin 笔记,用于以编程方式创建、读取、更新、删除或搜索 Joplin 笔记
通过 REST API 管理 Joplin 笔记,用于以编程方式创建、读取、更新、删除或搜索 Joplin 笔记
Manage Joplin notes programmatically via REST API for create, read, update, delete, and search operations
Manage Joplin notes via REST API. Use for creating, reading, updating, deleting, or searching Joplin notes programmatically.
直接复制以下提示词,发送给你的 AI 助手即可完成安装。
---
name: joplin-api
description: Manage Joplin notes via REST API. Use for creating, reading, updating, deleting, or searching Joplin notes programmatically.
allowed-tools: Bash(joplin-api:*)
homepage: https://joplinapp.org/help/api/references/rest_api/
metadata:
openclaw:
requires:
bins: [python3]
install:
- id: deps
kind: pip
package: requests python-dotenv
label: Install Python dependencies
env:
- name: JOPLIN_BASE_URL
required: false
default: http://localhost:41184
description: Joplin Data API base URL
- name: JOPLIN_TOKEN
required: true
description: API Token from Joplin Web Clipper settings
- name: JOPLIN_IMPORT_DIR
required: false
default: /root/.openclaw/workspace
description: Allowed directory for import operations
- name: JOPLIN_EXPORT_DIR
required: false
default: /root/.openclaw/workspace
description: Allowed directory for export operations
---
# Joplin API Skill
Manage Joplin notes, notebooks, and tags via Joplin Data API.
---
## Environment Variables
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `JOPLIN_BASE_URL` | No | `http://localhost:41184` | Joplin API URL |
| `JOPLIN_TOKEN` | **Yes** | - | API Token from Web Clipper |
---
## Quick Start
### 1. Get API Token
1. Open Joplin → **Tools** → **Options** → **Web Clipper**
2. Enable service and copy the token
### 2. Test Connection
```bash
python3 joplin.py ping
```
---
## Basic Commands
```bash
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
文件内容直接读取自技能仓库,仅供安装前审阅;以实际下载的压缩包为准。