跳至主要内容

API 參考

後端提供一組 REST API,加上一個用於執行的 WebSocket。所有端點都位於與應用程式相同的來源下(預設為 http://localhost:8000)。

端點方法說明
/api/healthGET健康探測——回傳 nodes_loadedpresets_loaded
/api/nodesGET列出所有節點定義。
/api/nodes/{node_name}GET取得單一節點定義。
/api/nodes/reloadPOST熱重載所有內建與自訂節點。
/api/presetsGET列出預設模組定義。
/api/presets/{name}GET取得單一預設模組定義。
/api/presets/createPOST從選取的節點建立新預設模組。
/api/graph/validatePOST驗證一張圖。
/api/graph/savePOST儲存一張圖。
/api/graph/load/{name}GET載入一張已儲存的圖。
/api/graph/listGET列出已儲存的圖。
/api/graph/exportPOST將一張圖匯出為 Python 腳本。
/api/examples/listGET列出範例圖。
/api/examples/loadGET載入一張範例圖。
/api/custom-nodesGET列出自訂節點。
/api/custom-nodes/uploadPOST上傳一個自訂節點。
/api/custom-nodes/togglePOST啟用/停用一個自訂節點。
/api/custom-nodes/{filename}DELETE刪除一個自訂節點。
/api/pluginsGET列出已安裝的外掛包。
/api/plugins/{id}GET取得某外掛的資訊清單 (manifest) 與 README。
/api/plugins/reloadPOST熱重載所有節點與預設模組來源。
/api/modelsGET列出已上傳的模型檔案。
/api/models/uploadPOST上傳一個模型權重檔。
/api/models/download/{filename}GET下載一個模型權重檔(支援巢狀路徑)。
/api/models/{filename}DELETE刪除一個模型檔案。
/api/imagesGET列出已上傳的影像檔案。
/api/images/uploadPOST上傳一個影像檔案。
/api/images/download/{filename}GET下載一個影像檔案。
/api/images/{filename}DELETE刪除一個影像檔案。
/api/execution/outputs/{run_id}GET列出某次執行所捕獲的連接埠。
/api/execution/outputs/{run_id}DELETE清除某次捕獲的執行。
/api/execution/outputs/{run_id}/{node_id}/{port}GET取得一個已捕獲的張量(支援 ?slice=0,:,:)。
/api/execution/outputs/{run_id}/{node_id}/__steps_indexGET某節點的步驟追蹤 metadata(檢視器 → Steps 分頁)。
/api/execution/outputs/{run_id}/{node_id}/__grad_indexGET已捕獲的梯度 metadata(檢視器 → Backward 分頁)。
/api/execution/state/resetPOST重設已保存的層權重(單節點或整張圖)。
/api/execution/state/listGET列出有多少模組被保存(診斷用)。
/ws/executionWebSocket即時圖執行(接受 run_idrecord_outputs)。

:::note WebSocket 驗證 執行 WebSocket 以查詢參數的形式取得其工作階段 token,因為瀏覽器無法在 WebSocket 交握時設定自訂標頭。前端會為你處理這件事。 :::