pulse-editor：使用 Vibe Dev Flow API 生成 Pulse 应用

名称： Pulse Editor Vibe Dev Flow
描述： 使用 Vibe Dev Flow API 生成和构建 Pulse 应用。当用户需要创建、更新或为 Pulse Editor 应用程序生成代码时，使用此技能。

概述

此技能使您能够与 Pulse Editor Vibe Dev Flow API 交互，利用基于云的 AI 编码代理来生成、构建和发布 Pulse 应用。该 API 使用服务器发送事件（SSE）流式传输来提供实时进度更新。

为何使用此技能

此技能为 AI 代理提供了显著优势：

• 无需本地代码生成：代理可以将代码生成任务卸载到 Pulse Editor 基于云的 Vibe 编码服务，而无需在用户本地机器上生成代码。这消除了对本地构建工具、依赖项或开发环境的需求。
• 内置版本控制：每次应用生成都会自动进行版本管理。代理可以通过指定 appId 和 version 来更新现有应用，从而轻松迭代应用程序，无需手动管理版本。
• 即时部署：应用在生成后会自动构建并立即发布。无需单独的构建或部署步骤——生成完成后，用户即可获得一个可用的实时应用 URL。
• 并行应用生成：代理可以通过并发 API 调用同时生成多个应用。这非常适合需要同时搭建多个微服务、创建多个相关应用或为不同目的批量生成应用的场景。
• 无状态且可扩展：由于所有代码生成都在云端进行，代理保持轻量级，并且可以水平扩展，无需担心本地资源限制。

重要提示：长时间运行任务

此 API 调用是一个长时间运行的操作。 Vibe Dev Flow 执行多个步骤，包括工作区创建、AI 代码生成、构建和发布。

• 预计持续时间：通常为 2-5 分钟，但复杂的应用可能需要更长时间。
• 超时阈值：除非请求超过 10 分钟，否则不要超时。
• SSE 流式传输：连接在整个过程中保持打开状态。即使一段时间内没有收到 SSE 消息，只要连接保持打开，请求就并未停滞或卡住。 请等待流结束或 10 分钟超时。
• 令牌效率：代理应在请求体中使用 "streamUpdatePolicy": "artifactOnly"，以便仅接收最终工件输出，从而显著减少输入令牌。但即使一段时间没有收到消息，也不应视为卡住。

何时使用此技能

当用户希望执行以下操作时，请使用此技能：

• 根据描述或提示创建新的 Pulse 应用
• 为现有 Pulse 应用添加新功能进行更新
• 为 Pulse Editor 应用程序生成代码
• 构建并发布 Pulse 应用

API 认证

Pulse Editor API 需要 API 密钥进行身份验证。用户可以通过以下方式获取其 API 密钥：

1. 在 https://pulse-editor.com/ 注册或登录。
2. 进入账户设置下的 开发者 部分。
3. （如果需要）在 https://pulse-editor.com/beta 申请 Beta 访问权限。
4. 在开发者部分创建并复制 API 密钥。

API 密钥应在 Authorization 请求头中以 Bearer 令牌形式传递：

Authorization: Bearer your_api_key_here

API 端点

POST https://pulse-editor.com/api/server-function/vibe_dev_flow/latest/generate-code/v2/generate

请求头

请求体参数

响应

响应是一个服务器发送事件（SSE）流。每个事件包含一个 JSON 编码的消息。消息之间由 \n\n 分隔。

每个 SSE 消息的格式为：

data: <JSON>

后跟一个空行。

消息类型

有两种消息类型：

创建消息 - 流中的新消息：

{
  "messageId": "msg_abc123",
  "type": "creation",
  "data": {
    "type": "text" | "toolCall" | "toolResult" | "artifactOutput",
    "result": "string content",
    "error": "error message if any"
  },
  "isFinal": false
}

更新消息 - 对现有消息的增量更新：

{
  "messageId": "msg_abc123",
  "type": "update",
  "delta": {
    "result": "additional content to append",
    "error": "additional error to append"
  },
  "isFinal": true
}

数据类型

工件输出格式

当生成完成时，artifactOutput 消息包含：

{
  "publishedAppLink": "https://pulse-editor.com/app/...",
  "sourceCodeArchiveLink": "https://...",
  "appId": "my_app_x7k9q2",
  "version": "0.0.1"
}

响应状态码

使用示例

cURL 示例

curl -L 'https://pulse-editor.com/api/server-function/vibe_dev_flow/latest/generate-code/v2/generate' \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/event-stream' \
  -H 'Authorization: Bearer your_api_key_here' \
  -d '{
    "prompt": "Create a todo app with auth and dark mode",
    "appName": "My Todo App"
  }'

Python 示例

import requests
import json

url = "https://pulse-editor.com/api/server-function/vibe_dev_flow/latest/generate-code/v2/generate"

headers = {
    "Authorization": "Bearer your_api_key_here",
    "Content-Type": "application/json",
    "Accept": "text/event-stream"
}

payload = {
    "prompt": "Create a todo app with auth and dark mode",
    "appName": "My Todo App"
}

response = requests.post(url, json=payload, headers=headers, stream=True)

messages = {}  # 按 messageId 跟踪消息
buffer = ""

for chunk in response.iter_content(chunk_size=None, decode_unicode=True):
    buffer += chunk

    # SSE 消息以 \n\n 结尾
    while "\n\n" in buffer:
        part, buffer = buffer.split("\n\n", 1)

        if not part.startswith("data:"):
            continue

        data = json.loads(part.replace("data: ", "", 1))

        if data["type"] == "creation":
            messages[data["messageId"]] = data
            print(f"New: {data['data'].get('result', '')}")

        elif data["type"] == "update":
            msg = messages.get(data["messageId"])
            if msg:
                msg["data"]["result"] = (msg["data"].get("result") or "") + (data["delta"].get("result") or "")
                msg["isFinal"] = data["isFinal"]

        # 检查工件输出
        if data.get("data", {}).get("type") == "artifactOutput" and data.get("isFinal"):
            result = json.loads(messages[data["messageId"]]["data"]["result"])
            print(f"Published: {result.get('publishedAppLink')}")

JavaScript/Node.js 示例

const response = await fetch(
  "https://pulse-editor.com/api/server-function/vibe_dev_flow/latest/generate-code/v2/generate",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer your_api_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      prompt: "Create a todo app with auth and dark mode",
      appName: "My Todo App",
    }),
  },
);

const reader = response.body.getReader();
const decoder = new TextDecoder();
let buffer = "";
const messages = new Map();

while (true) {
  const { done, value } = await reader.read();
  if (done) break;

  buffer += decoder.decode(value, { stream: true });

  // SSE 消息以 \n\n 结尾
  const parts = buffer.split("\n\n");
  buffer = parts.pop(); // 将不完整的部分保留在缓冲区中

  for (const part of parts) {
    if (!part.startsWith("data:")) continue;

    const json = part.replace(/^data:\s*/, "");
    const message = JSON.parse(json);

    if (message.type === "creation") {
      messages.set(message.messageId, message);
    } else if (message.type === "update") {
      const msg = messages.get(message.messageId);
      if (msg) {
        msg.data.result =
          (msg.data.result ?? "") + (message.delta.result ?? "");
        msg.data.error = (msg.data.error ?? "") + (message.delta.error ?? "");
        msg.isFinal = message.isFinal;
      }
    }

    // 检查最终工件输出
    const msg = messages.get(message.messageId);
    if (msg?.data.type === "artifactOutput" && msg.isFinal) {
      const result = JSON.parse(msg.data.result);
      console.log("Published:", result.publishedAppLink);
    }
  }
}

更新现有应用

要更新现有应用，请包含 appId 和可选的 version：

curl -L 'https://pulse-editor.com/api/server-function/vibe_dev_flow/latest/generate-code/v2/generate' \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/event-stream' \
  -H 'Authorization: Bearer your_api_key_here' \
  -d '{
    "prompt": "Add a calendar view to display tasks by date",
    "appName": "My Todo App",
    "appId": "my_app_x7k9q2",
    "version": "0.0.1"
  }'

最佳实践

1. 清晰的提示：提供详细、具体的提示来描述您希望应用实现的功能。
2. 正确处理 SSE：实时处理流式响应以获取进度更新。
3. 错误处理：针对 400、401 和 500 响应实施适当的错误处理。
4. API 密钥安全：切勿硬编码 API 密钥；请使用环境变量或安全存储。
5. 版本控制：更新应用时，请指定版本以确保在正确的基础上进行构建。

故障排除

包含的示例

此技能在 examples/ 文件夹中包含一个可直接运行的 Python 示例：

• examples/generate_app.py - 完整的 Python 脚本，演示了使用 Vibe Dev Flow API 进行 SSE 流式传输。
• examples/generate_app.js - 完整的 Node.js 脚本，演示了使用 Vibe Dev Flow API 进行 SSE 流式传输。

运行 Python 示例脚本：

# 设置您的 API 密钥
export PULSE_EDITOR_API_KEY=your_api_key_here  # Linux/Mac
set PULSE_EDITOR_API_KEY=your_api_key_here     # Windows

# 安装依赖项
pip install requests

# 运行脚本
python examples/generate_app.py

运行 Node.js 示例脚本：

# 设置您的 API 密钥
export PULSE_EDITOR_API_KEY=your_api_key_here  # Linux/Mac
set PULSE_EDITOR_API_KEY=your_api_key_here     # Windows
# 安装依赖项
npm install node-fetch
# 运行脚本
node examples/generate_app.js

资源

• Pulse Editor 文档
• API 参考
• 获取 API 密钥
• Discord 社区
• GitHub