工作流

client.workflows 管理 Imbrace 流程引擎：创建和触发自动化流程、查看运行历史、使用文件夹组织、管理应用连接和 MCP 服务器，以及访问工作流表格。

Schema

Flow

字段	类型	说明
`id`	string	唯一流程 ID
`created`	string	ISO 8601 创建时间戳
`updated`	string	ISO 8601 更新时间戳
`projectId`	string	所属项目
`externalId`	string	可选外部标识符
`status`	`"ENABLED"` \| `"DISABLED"`	流程是否启用
`operationStatus`	string	当前操作状态
`version`	FlowVersion	启用中的版本对象

FlowVersion

字段	类型	说明
`id`	string	唯一版本 ID
`created`	string	ISO 8601 创建时间戳
`updated`	string	ISO 8601 更新时间戳
`flowId`	string	此版本所属的流程
`displayName`	string	人类可读的流程名称
`trigger`	object	触发器配置
`steps`	object?	可选步骤配置
`valid`	boolean?	版本是否有效

FlowRun

字段	类型	说明
`id`	string	唯一运行 ID
`created`	string	ISO 8601 创建时间戳
`updated`	string	ISO 8601 更新时间戳
`projectId`	string	项目 ID
`flowId`	string	已执行的流程
`flowVersionId`	string	运行的特定版本
`status`	`"RUNNING"` \| `"SUCCEEDED"` \| `"FAILED"` \| `"TIMEOUT"` \| `"PAUSED"` \| `"STOPPED"`	运行结果
`environment`	`"PRODUCTION"` \| `"TESTING"`	执行环境
`startTime`	string?	运行开始时间
`finishTime`	string?	运行结束时间
`failParentOnFailure`	boolean	失败是否传播到父流程
`tags`	string[]?	附加到此运行的标签

AppConnection

字段	类型	说明
`id`	string	唯一连接 ID
`created`	string	ISO 8601 创建时间戳
`updated`	string	ISO 8601 更新时间戳
`externalId`	string	外部标识符
`displayName`	string	人类可读名称
`pieceName`	string	此连接所属的 piece（集成）
`projectId`	string	项目 ID
`type`	`"SECRET_TEXT"` \| `"OAUTH2"` \| `"CLOUD_OAUTH2"` \| `"PLATFORM_OAUTH2"` \| `"BASIC_AUTH"` \| `"CUSTOM_AUTH"`	连接认证类型

McpServer

字段	类型	说明
`id`	string	唯一 MCP 服务器 ID
`created`	string	ISO 8601 创建时间戳
`updated`	string	ISO 8601 更新时间戳
`projectId`	string	项目 ID
`name`	string?	服务器名称

方法

流程

方法	TypeScript	Python	说明
列出流程	`listFlows`	`list_flows`	分页的流程列表
获取流程	`getFlow`	`get_flow`	按 ID 获取单个流程
创建流程	`createFlow`	`create_flow`	创建新流程
删除流程	`deleteFlow`	`delete_flow`	删除流程
应用流程操作	`applyFlowOperation`	`apply_flow_operation`	对流程应用操作（例如发布、启用）
触发流程	`triggerFlow`	`trigger_flow`	异步触发流程
同步触发流程	`triggerFlowSync`	`trigger_flow_sync`	触发流程并等待结果

流程运行

方法	TypeScript	Python	说明
列出运行	`listRuns`	`list_runs`	列出运行历史
获取运行	`getRun`	`get_run`	按 ID 获取单个运行

文件夹

方法	TypeScript	Python	说明
列出文件夹	`listFolders`	`list_folders`	列出流程文件夹
获取文件夹	`getFolder`	`get_folder`	按 ID 获取文件夹
创建文件夹	`createFolder`	`create_folder`	创建文件夹
更新文件夹	`updateFolder`	`update_folder`	重命名文件夹
删除文件夹	`deleteFolder`	`delete_folder`	删除文件夹

应用连接

方法	TypeScript	Python	说明
列出连接	`listConnections`	`list_connections`	列出应用连接
获取连接	`getConnection`	`get_connection`	按 ID 获取连接
创建或更新连接	`upsertConnection`	`upsert_connection`	创建或更新连接
删除连接	`deleteConnection`	`delete_connection`	移除连接

MCP 服务器

方法	TypeScript	Python	说明
列出 MCP 服务器	`listMcpServers`	`list_mcp_servers`	列出 MCP 服务器
获取 MCP 服务器	`getMcpServer`	`get_mcp_server`	按 ID 获取服务器
创建 MCP 服务器	`createMcpServer`	`create_mcp_server`	注册新的 MCP 服务器
删除 MCP 服务器	`deleteMcpServer`	`delete_mcp_server`	移除服务器
轮换令牌	`rotateMcpToken`	`rotate_mcp_token`	轮换服务器的认证令牌

const page = await client.workflows.listFlows({
  limit: 10,
  status: "ENABLED",
  folderId: "folder_id",
});
for (const flow of page.data) {
  console.log(flow.id, flow.version?.displayName);
}

page = client.workflows.list_flows(limit=10, status="ENABLED", folder_id="folder_id")
for flow in page.get("data", []):
    print(flow["id"])

createFlow / create_flow

TypeScript
Python

const flow = await client.workflows.createFlow({
  displayName: "New Lead Notification",
  projectId: "project_id",
});
console.log(flow.id);

flow = client.workflows.create_flow(
    display_name="New Lead Notification",
    project_id="project_id",
)
print(flow["id"])

triggerFlow / trigger_flow

使用可选负载异步触发流程。

TypeScript
Python

await client.workflows.triggerFlow("flow_id", {
  contact_id: "contact_123",
  event: "lead_created",
});

client.workflows.trigger_flow("flow_id", {
    "contact_id": "contact_123",
    "event": "lead_created",
})

listRuns / list_runs

TypeScript
Python

const page = await client.workflows.listRuns({
  flowId: "flow_id",
  status: "FAILED",
  limit: 20,
});

page = client.workflows.list_runs(
    flow_id="flow_id",
    status="FAILED",
    limit=20,
)

upsertConnection / upsert_connection

创建或更新应用连接（例如第三方服务的 API 密钥）。

TypeScript
Python

const conn = await client.workflows.upsertConnection({
  displayName: "Slack Workspace",
  pieceName: "slack",
  projectId: "project_id",
  type: "SECRET_TEXT",
  value: { api_key: "xoxb-..." },
});

conn = client.workflows.upsert_connection({
    "displayName": "Slack Workspace",
    "pieceName": "slack",
    "projectId": "project_id",
    "type": "SECRET_TEXT",
    "value": {"api_key": "xoxb-..."},
})

createMcpServer / create_mcp_server

TypeScript
Python

const server = await client.workflows.createMcpServer({
  name: "My MCP Server",
  projectId: "project_id",
});

server = client.workflows.create_mcp_server({
    "name": "My MCP Server",
    "projectId": "project_id",
})