muapi-workflow

AI 工作流构建器

将任意组合的 muapi.ai 生成步骤串联成自动化流水线。AI 架构师会将你的自然语言描述转换为可运行的节点图。

前置条件

运行任何命令前，请务必确保 muapi CLI 为最新版本。每次会话开始时都要从源代码重新安装：

pip install --upgrade /path/to/muapi-cli

将 /path/to/muapi-cli 替换为工作区中 muapi-cli 目录的实际路径（即包含 pyproject.toml 的目录）。

核心操作

1. 生成（generate-workflow.sh）— AI 架构师根据描述创建工作流
2. 发现（discover-workflow.sh）— 通过自然语言查找相关的现有工作流
3. 编辑（generate-workflow.sh --workflow-id）— 使用提示词修改现有工作流
4. 交互式运行（interactive-run.sh）— 提示输入并执行工作流
5. 运行（run-workflow.sh）— 执行工作流，逐个轮询节点并收集输出
6. CLI（muapi workflow）— 直接在终端中执行完整的 CRUD 操作和可视化

---

Agent 引导式发现与选择

作为 AI Agent，你可以读取并理解可用工作流的用途，从而为用户的任务（例如“创建 UGC 视频”）选择最合适的工作流。

1. 发现：以 JSON 格式获取可用工作流目录及其描述。

   muapi workflow discover --output-json
   

2. 匹配（内部推理）：利用你的大模型能力分析返回工作流的 name、category 和 description 字段。找到最符合用户意图的工作流。
3. 分析：如果找到有希望的候选项，请检查其结构，确认它包含所需的节点和参数。

   muapi workflow get <workflow_id>
   

   重要规则：muapi workflow get 的输出会包含一个“API Inputs”表格。你必须阅读此表格，了解所需的输入。
4. 选择、确认并询问用户：
   • 如果某个工作流完全符合要求，你必须在执行前要求用户提供所需 API 输入的确切值。切勿自行编造或猜测输入值（例如提示词、URL 等）。
   • 如果有多个工作流高度相关，请向用户展示这些选项及其描述，并询问用户要使用哪一个，同时询问所需的输入。
   • 如果没有工作流符合用户的复杂请求，则提供使用 muapi workflow create 构建新工作流的选项。

Agent 推理示例

“用户想要制作一段产品宣传视频。我通过 discover 获取了目录。我发现两个可能的工作流：

1. wf_123：‘带背景音乐的产品宣传’
2. wf_456：‘简单视频生成’ 我将使用 get 分析 wf_123。它包含所需节点。我会向用户推荐 wf_123，或者在匹配精准时直接运行。”

---

协议：构建工作流

第 1 步 — 描述你的流水线

muapi workflow create "take a text prompt, generate an image with flux-dev, then upscale it to 4K"

架构师会返回一个包含唯一 ID 和节点图的工作流。请保存该 ID。

第 2 步 — 检查并可视化

# Rich ASCII node graph in the terminal
muapi workflow get <workflow_id>

# Or raw JSON
muapi workflow get <workflow_id> --output-json

第 3 步 — 运行

# Run with specific inputs
muapi workflow execute <workflow_id> \
  --input "node1.prompt=a glowing crystal cave at midnight"

# Use --download to pull results locally
muapi workflow execute <workflow_id> \
  --input "node1.prompt=a sunset" \
  --download ./outputs

第 4 步 — 发现（可选）

如果你想复用现有工作流，而不是创建新工作流：

# Search by keywords
muapi workflow discover "ugc video"

第 5 步 — 交互式执行

运行工作流，并让 CLI 提示你输入每项必需输入：

muapi workflow run-interactive <workflow_id>

---

工作流示例

图像流水线

# Text → Image → Upscale
muapi workflow create "take a text prompt, generate with flux-dev, upscale the result"

# Text → Image → Background removal → Product shot
muapi workflow create "generate a product image with hidream, remove background, create professional product shot"

视频流水线

# Text → Video
muapi workflow create "generate a 10-second cinematic video from a text prompt using kling-master"

# Image → Video → Lipsync
muapi workflow create "animate an input image with seedance, then apply lipsync from an audio file"

---

编辑现有工作流

# Add a step
muapi workflow edit <id> --prompt "add a face-swap step after the image generation"

# Swap a model
muapi workflow edit <id> --prompt "change the video model from kling to veo3"

---

CLI 参考

# List all your workflows
muapi workflow list

# Browse templates
muapi workflow templates

# Generate new workflow
muapi workflow create "text → flux image → upscale → face swap"

# Visualize a workflow
muapi workflow get <id>

# Execute with inputs
muapi workflow execute <id> --input "node1.prompt=a sunset"

# Monitor a run
muapi workflow status <run_id>

# Get outputs
muapi workflow outputs <run_id> --download ./results

# Edit with AI
muapi workflow edit <id> --prompt "add lipsync at the end"

# Rename / delete
muapi workflow rename <id> --name "Product Pipeline v2"
muapi workflow delete <id>

---

MCP 工具（供 AI Agent 使用）

工具	描述
muapi_workflow_list	列出用户的工作流
muapi_workflow_create	AI 架构师：提示词 → 工作流
muapi_workflow_get	获取工作流定义和节点图
muapi_workflow_execute	使用指定输入运行
muapi_workflow_status	逐节点运行状态
muapi_workflow_outputs	最终输出 URL

---

限制

• 工作流可以包含任意组合的 muapi.ai 节点（图像、视频、音频、增强、编辑）
• 节点输出会自动接入下游节点，作为其输入
• --sync 模式最多等待 120s 以完成生成；对于复杂工作流，请使用 --async 并单独轮询
• 每次工作流执行的运行超时时间最长为 10 分钟