Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Read and write Obsidian notes stored in EVC Team Relay collaborative vault. Use when agent needs to: read note content from a shared Obsidian vault, create o...
Read and write Obsidian notes stored in EVC Team Relay collaborative vault. Use when agent needs to: read note content from a shared Obsidian vault, create o...
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
REST API skill for reading and writing collaborative Obsidian vault documents via EVC Team Relay.
VariableRequiredDescriptionRELAY_CP_URLyesControl plane URL, e.g. https://cp.tr.entire.vcRELAY_EMAILyesUser email for authenticationRELAY_PASSWORDyesUser passwordRELAY_TOKENnoJWT token (set via export RELAY_TOKEN=$(scripts/auth.sh))
# 1. Authenticate โ get a JWT token (stored in env var, not visible in ps) export RELAY_TOKEN=$(scripts/auth.sh) # 2. List shares to find available documents scripts/list-shares.sh # 3. Read a file from a folder share BY PATH (most common) scripts/read-file.sh <folder_share_id> "Marketing/plan.md" # 4. Create or update a file in a folder share scripts/upsert-file.sh <folder_share_id> "note.md" "# Content" # 5. List all files in a folder share scripts/list-files.sh <folder_share_id> # 6. Delete a file from a folder share scripts/delete-file.sh <folder_share_id> "old-note.md" # 7. Read a doc share (single document, share_id = doc_id) scripts/read.sh <share_id> # 8. Write to a doc share scripts/write.sh <share_id> <share_id> "# Updated content" All scripts accept the token via RELAY_TOKEN env var (preferred) or as the first CLI argument (backward-compatible).
Doc shareFolder shareContainsSingle documentMultiple filesdoc_idSame as share_idEach file has its own doc_id (in folder metadata)Readread.sh <share_id>read-file.sh <share_id> "path/to/file.md"Writewrite.sh <share_id> <share_id> <content>upsert-file.sh <share_id> "path" <content>DeleteN/Adelete-file.sh <share_id> "path" Most shares are folder shares. Use read-file.sh and upsert-file.sh โ they handle path resolution automatically. Warning: write.sh does NOT work for folder shares โ it writes content but does not register the file in folder metadata, so Obsidian will never see it. The script detects folder shares and refuses with an error.
ScriptPurposeArgsauth.shGet JWT tokenโlist-shares.shList all shares[kind] [owned_only]list-files.shList files in folder share<share_id>read-file.shRead file by path (folder share)<share_id> <file_path>read.shRead by doc_id (low-level)<share_id> [doc_id]upsert-file.shCreate/update file (folder share)<share_id> <file_path> <content>write.shWrite by doc_id (doc shares only)<share_id> <doc_id> <content>delete-file.shDelete file from folder share<share_id> <file_path>create-file.shCreate new file (low-level)<share_id> <file_path> <content> Bold = recommended for most use cases. All scripts use RELAY_TOKEN env var (or accept token as first arg).
All API calls require a Bearer JWT token. Get one via login: curl -s -X POST "$RELAY_CP_URL/v1/auth/login" \ -H "Content-Type: application/json" \ -d '{"email": "'$RELAY_EMAIL'", "password": "'$RELAY_PASSWORD'"}' \ | jq -r '.access_token' Response: { "access_token": "eyJ...", "refresh_token": "...", "token_type": "bearer", "expires_in": 3600 } Use the access_token as Authorization: Bearer <token> header on all subsequent requests. When the token expires (1 hour), refresh it: curl -s -X POST "$RELAY_CP_URL/v1/auth/refresh" \ -H "Content-Type: application/json" \ -d '{"refresh_token": "'$REFRESH_TOKEN'"}'
Shares are the access units โ each share maps to a document or folder in the Obsidian vault. curl -s "$RELAY_CP_URL/v1/shares" \ -H "Authorization: Bearer $TOKEN" | jq Response (array): [ { "id": "a1b2c3d4-...", "kind": "doc", "path": "Projects/meeting-notes.md", "visibility": "private", "is_owner": true, "user_role": null, "web_published": false }, { "id": "e5f6g7h8-...", "kind": "folder", "path": "Projects/", "visibility": "private", "is_owner": false, "user_role": "editor" } ] Key fields: id โ share UUID, used as share_id in all operations kind โ doc (single file) or folder (directory) path โ Obsidian vault-relative path user_role โ viewer (read-only), editor (read-write), or null (owner) Filter options: ?kind=doc, ?owned_only=true, ?member_only=true, ?skip=0&limit=50.
scripts/list-files.sh <share_id> Response: { "doc_id": "e5f6g7h8-...", "files": { "meeting-notes.md": {"doc_id": "abc123-...", "type": "markdown"}, "project-plan.md": {"doc_id": "def456-...", "type": "markdown"} } } Each key is the file's path within the folder. The doc_id field is the document identifier used for content operations. The share_id for content requests is always the folder share's ID. Note: The API response uses id as the field name. This is the same as doc_id โ use it wherever doc_id is needed.
scripts/read-file.sh <folder_share_id> "Marketing/plan.md" This resolves the path to a doc_id internally and returns: { "doc_id": "abc123-...", "content": "# Marketing Plan\n\nContent here...", "format": "text", "path": "Marketing/plan.md" }
scripts/read.sh <share_id> [doc_id] [key] For doc shares, omit doc_id (defaults to share_id). For folder shares, pass the file's doc_id from list-files.sh.
# Create or update โ auto-detects which operation is needed scripts/upsert-file.sh <folder_share_id> "note.md" "# Updated content" # Pipe content from stdin echo "# Content" | scripts/upsert-file.sh <folder_share_id> "note.md" - Response includes an operation field: "created" or "updated".
scripts/write.sh <share_id> <share_id> "# Updated Notes" write.sh refuses folder shares โ if you accidentally pass a folder share_id as doc_id, it detects this and exits with an error directing you to upsert-file.sh.
# If you know the folder share_id: scripts/read-file.sh <folder_share_id> "Marketing/docs/plan.md" # If you need to find the share first: scripts/list-shares.sh # find the folder share scripts/read-file.sh <share_id> "path/to/file.md"
# Always works, whether the file exists or not scripts/upsert-file.sh <folder_share_id> "note.md" "# Content"
scripts/delete-file.sh <folder_share_id> "old-note.md"
StatusMeaning400Invalid share_id format401Missing or expired token โ re-authenticate403Insufficient permissions (viewer trying to write, or non-member)404Share or file not found (check path spelling, use list-files.sh to verify)422Missing required field (share_id, content)502Relay server unavailable โ retry later
TermMeaningshare_idUUID of a share (doc or folder). Used for ACL checks in all requests.doc_idUUID of an individual document. For doc shares, equals share_id. For folder shares, each file has its own doc_id.idSame as doc_id โ the API response field name. Use interchangeably.file_pathRelative path within a folder share (e.g. "Marketing/plan.md").
references/api.md โ full API reference with all endpoints
Writing, remixing, publishing, visual generation, and marketing content production.
Largest current source with strong distribution and engagement signals.