SDK 方法參考

CLI 透過 @imbrace/sdk 直接與 Imbrace 平台通訊。此頁面將每個指令群組對應至底層的 SDK 方法。

如需完整的 SDK 參考，請參閱 SDK 概覽。

資料看板 — `client.boards`

CLI 指令	SDK 方法
`data-board list`	`client.boards.list()`
`data-board create`	`client.boards.create(body)`
`data-board create-field <boardId>`	`client.boards.createField(boardId, body)`
`data-board create-item <boardId>`	`client.boards.createItem(boardId, body)`
`data-board list-items`	`client.boards.listItems(boardId, params)` 或 `client.boards.search(boardId, { q })`
`data-board update-item <boardId> <itemId>`	`client.boards.updateItem(boardId, itemId, body)`
`data-board delete-item <boardId> <itemId>`	`client.boards.deleteItem(boardId, itemId)`
`data-board export-csv`	`client.boards.exportCsv(boardId)`

AI 代理 — `client.agent`, `client.chatAi`, `client.ai`, `client.boards`

大多數 AI Agent 指令使用 client.agent 資源（使用案例管理）。更新時還會另外使用 client.chatAi。

CLI 指令	SDK 方法
`ai-agent list`	`client.agent.list()`
`ai-agent get <id>`	`client.agent.get(id)`
`ai-agent create`	`client.agent.createUseCase(body)`
`ai-agent update <id>`	`client.agent.updateUseCase(id, body)` + `client.chatAi.updateAiAgent(assistantId, body)`
`ai-agent delete <id>`	`client.agent.delete(id)`
`ai-agent list-providers`	`client.ai.listProviders()`
`ai-agent list-models --provider-id <id>`	`client.ai.listProviders()`（於記憶體中篩選）
`ai-agent list-folders`	`client.boards.searchFolders(query)`
`ai-agent list-files --folder-id <id>`	`client.boards.searchFiles({ folderId })`

Document AI — `client.documentAi`

CLI 指令	SDK 方法
`document-ai list`	`client.documentAi.listAgents(params)`
`document-ai get <id>`	`client.documentAi.getAgent(id)`
`document-ai create`	`client.documentAi.createAgent(body)`
`document-ai update <id>`	`client.documentAi.updateAgent(id, body)`
`document-ai delete <id>`	`client.documentAi.deleteAgent(id)`
`document-ai process`	`client.documentAi.process(body)`
`document-ai suggest-schema`	`client.documentAi.suggestSchema(body)`

編排器 — `client.agent`, `client.chatAi`

Orchestrator 是 agent_type: "team_lead" 的特殊 AI Agent。它使用相同的 client.agent 資源，並透過 client.chatAi 修補子 agent 欄位。

CLI 指令	SDK 方法
`orchestrator list`	`client.agent.list()`
`orchestrator get <id>`	`client.agent.get(id)`
`orchestrator create`	`client.agent.createUseCase(body)` + `client.chatAi.updateAiAgent(assistantId, body)`
`orchestrator delete <id>`	`client.agent.delete(id)`

安全護欄 — `client.ai`, `client.account`

CLI 指令	SDK 方法
`guardrail list`	`client.ai.listGuardrails()`
`guardrail get <id>`	`client.ai.getGuardrail(id)`
`guardrail create`	`client.ai.createGuardrail(body)`（+ `client.account.getAccount()` 以解析組織 ID）
`guardrail update <id>`	`client.ai.updateGuardrail(id, body)`
`guardrail delete <id>`	`client.ai.deleteGuardrail(id)`

工作流程 — `client.workflows`

CLI 指令	SDK 方法
`workflow list`	`client.workflows.listFlows(params)`
`workflow get <id>`	`client.workflows.getFlow(id)`
`workflow create`	`client.workflows.createFlow(body)`
`workflow delete <id>`	`client.workflows.deleteFlow(id)`
`workflow move <id>`	`client.workflows.applyFlowOperation(id, CHANGE_FOLDER)`
`workflow publish <id>`	`client.workflows.applyFlowOperation(id, LOCK_AND_PUBLISH)`
`workflow enable <id>`	`client.workflows.applyFlowOperation(id, CHANGE_STATUS enabled)`
`workflow disable <id>`	`client.workflows.applyFlowOperation(id, CHANGE_STATUS disabled)`
`workflow run <id>`	`client.workflows.triggerFlow(id, payload)`（使用 `--sync` 時為 `triggerFlowSync`）
`workflow runs`	`client.workflows.listRuns()`
`workflow run-detail <runId>`	`client.workflows.getRun(runId)`
`workflow node list <id>`	`client.workflows.getFlow(id)`（解析後）
`workflow node add <id>`	`client.workflows.applyFlowOperation(id, ADD_ACTION / UPDATE_TRIGGER)`
`workflow node update <id> <node>`	`client.workflows.applyFlowOperation(id, UPDATE_ACTION)`
`workflow node delete <id> <node>`	`client.workflows.applyFlowOperation(id, DELETE_ACTION)`
`workflow node add-raw <id>`	`client.workflows.applyFlowOperation(id, body)`
`workflow piece list`	`client.workflows.listPieces()`
`workflow piece detail <pieceName>`	直接 HTTP：`GET /activepieces/v1/pieces/{pieceName}`，透過 `gatewayFetch()`
`workflow conn list`	`client.workflows.listConnections()`
`workflow conn get <connId>`	`client.workflows.getConnection(connId)`
`workflow conn create`	`client.workflows.upsertConnection(body)`
`workflow conn delete <id>`	`client.workflows.deleteConnection(id)`
`workflow folder list`	`client.workflows.listFolders()`
`workflow folder get <id>`	`client.workflows.getFolder(id)`
`workflow folder create`	`client.workflows.createFolder(body)`
`workflow folder update <id>`	`client.workflows.updateFolder(id, body)`
`workflow folder delete <id>`	`client.workflows.deleteFolder(id)`
`workflow mcp list`	`client.workflows.listMcpServers()`
`workflow mcp get <id>`	`client.workflows.getMcpServer(id)`
`workflow mcp create`	`client.workflows.createMcpServer(body)`
`workflow mcp delete <id>`	`client.workflows.deleteMcpServer(id)`
`workflow mcp rotate-token <id>`	`client.workflows.rotateMcpToken(id)`