跳至內容

雲端 API

Mindwtr Cloud 提供一套精簡的 bearer token API,用於同步、任務自動化與附件傳輸。它是為自行託管部署而設計,並使用與自行託管雲端後端相同的 token 命名空間。

驗證身分

每個 /v1/* 請求都要傳送 bearer token:

http
Authorization: Bearer <token>

正式環境請使用 MINDWTR_CLOUD_AUTH_TOKENSMINDWTR_CLOUD_AUTH_TOKENS_FILEMINDWTR_CLOUD_ALLOW_ANY_TOKEN=true 僅適用於受控的自動化流程,並透過 MINDWTR_CLOUD_ANY_TOKEN_MAX_NAMESPACES 限制新命名空間數量。

健康狀態

text
GET /health

無需驗證身分即可回傳伺服器健康狀態。

快照同步

text
GET /v1/data
PUT /v1/data

GET /v1/data 回傳已驗證命名空間的快照。若命名空間不存在且允許寫入,伺服器會建立空白快照。

PUT /v1/data 會驗證上傳的 AppData,以核心同步演算法和現有命名空間合併、驗證合併結果,再將結果寫回。這不是強制覆寫。成功的回應會回傳 { ok: true, stats, clockSkewWarning },其中 stats 的合併統計資料結構與本機同步診斷所用者相同。

任務

text
GET /v1/tasks
POST /v1/tasks
GET /v1/tasks/:id
PATCH /v1/tasks/:id
DELETE /v1/tasks/:id
POST /v1/tasks/:id/complete
POST /v1/tasks/:id/archive

清單查詢參數:

參數用途
query對任務標題與中繼資料進行不區分大小寫的文字搜尋。
status一種任務狀態:inboxnextwaitingsomedayreferencedonearchived
all=1納入已完成任務。
deleted=1納入軟刪除任務。
limit, offset頁面大小與起始位移。

建立時可接受 title 或快速新增的 input,以及選用的 props。修補操作接受雲端驗證層支援的任務欄位,並提高同步修訂版中繼資料。

專案、領域與區段

text
GET /v1/projects
POST /v1/projects
GET /v1/projects/:id
PATCH /v1/projects/:id
DELETE /v1/projects/:id

GET /v1/areas
POST /v1/areas
GET /v1/areas/:id
PATCH /v1/areas/:id
DELETE /v1/areas/:id

GET /v1/sections
POST /v1/sections
GET /v1/sections/:id
PATCH /v1/sections/:id
DELETE /v1/sections/:id

所有清單端點都接受 limitoffsetdeleted=1。區段也接受 projectId

參照欄位必須指向有效記錄。專案的 areaId 必須參照有效領域。使用 areaId: null 清除專案領域;areaId: "" 無效。區段的 projectId 必須參照有效專案。

刪除領域、專案與區段時會使用墓碑,並由伺服器端修復,以維持快照可用於同步。

搜尋

text
GET /v1/search?query=<text>

搜尋會在個別陣列中回傳有效的任務與專案。它支援共用的 limitoffset 參數,以及個別游標:

參數用途
taskLimit, taskOffset對任務結果集分頁。
projectLimit, projectOffset對專案結果集分頁。

回應包含 taskTotalprojectTotal 與實際採用的游標值。

附件

text
GET /v1/attachments/:path
PUT /v1/attachments/:path
DELETE /v1/attachments/:path

POST /v1/attachments/orphans
DELETE /v1/attachments/orphans

附件路徑會在已驗證 token 的命名空間內解析。上傳作業會強制執行設定的位元組限制與核心附件驗證規則。

孤立附件清理端點會掃描命名空間,尋找不再被 data.json 參照的檔案。它會略過最近五分鐘內修改的檔案,避免與後續快照寫入競爭的上傳遭到移除。

MCP 配接器

已發布的 mindwtr-mcp 輔助工具可使用自行託管的雲端端點作為後端。請透過 --cloud-url--cloud-token,或 MINDWTR_MCP_CLOUD_URLMINDWTR_MCP_CLOUD_TOKEN 環境變數進行設定。

以雲端為後端的 MCP 模式會讀取 /v1/data,並提供任務、專案、區段、領域與人物的讀取工具。加上 --write 後,任務、專案、區段與領域的變更會經由上述各資源的 REST 端點;此模式預設維持唯讀,也不會將 Mindwtr Cloud 本身變成託管式 MCP 服務。

相關頁面

Mindwtr 是免費、開放原始碼且在地優先的應用程式。
Getting Things Done 與 GTD 是 David Allen Company 的註冊商標。Mindwtr 與 David Allen Company 無關,亦未獲其背書或贊助。