> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 将 BuildShip 连接到 CometAPI

> 使用本指南，通过设置 base URL、API key 以及 model 或 provider 选项，将 BuildShip 连接到 CometAPI。

BuildShip 是一个低代码可视化后端构建工具。使用社区提供的 **CometAPI Text Generator** 节点，为任意工作流添加由 AI 驱动的文本生成功能。

## 前提条件

* 一个拥有有效 API key 的 CometAPI 账户——[在这里获取](https://www.cometapi.com/console/token)
* 一个 BuildShip 账户——[在这里登录](https://app.buildship.com)

<Steps>
  <Step title="获取你的 CometAPI API key">
    登录 [CometAPI 控制台](https://www.cometapi.com/console/token)。点击 **Add API Key** 并复制你的 CometAPI API key。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/overview/810968_364191.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=aef81a83f29f8eb16655ed4060425f50" alt="显示 Add API Key 按钮的 CometAPI 控制台" width="3824" height="1892" data-path="images/overview/810968_364191.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/cometapi/HhtmQffktazbxUvS/images/overview/810968_364193.png?fit=max&auto=format&n=HhtmQffktazbxUvS&q=85&s=d893f659267150d0faf45f99eb5dffc1" alt="包含 base URL 的 CometAPI API key 详情" width="2434" height="1232" data-path="images/overview/810968_364193.png" />
    </Frame>
  </Step>

  <Step title="创建一个带有 REST API 触发器的工作流">
    1. 在 BuildShip 控制台中，点击 **Create a new workflow → From Scratch**。
    2. 在画布上，点击 **Add Trigger** 并选择 **REST API**。这会为该工作流生成一个可调用的 endpoint。
  </Step>

  <Step title="添加 CometAPI Text Generator 节点">
    1. 在 REST API 触发器下方，点击 **+ Add a new step**。
    2. 在节点库搜索框中，输入 `cometapi`。
    3. 在 **Community** 列表中，选择 **CometAPI Text Generator**。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360694.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=4ac17cb84e36a7f026f618e2b5229bf2" alt="BuildShip 节点库搜索结果中显示 CometAPI Text Generator" width="1915" height="960" data-path="images/integrations/810968_360694.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360712.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=5da7aa2a5bef0d8a9ce45eceace876d1" alt="已添加到画布中的 CometAPI Text Generator 节点" width="1786" height="930" data-path="images/integrations/810968_360712.png" />
    </Frame>
  </Step>

  <Step title="关联 CometAPI 集成">
    此步骤用于告诉节点应使用哪个 key 管理系统。

    1. 点击节点，在右侧打开 **Node Editor**。
    2. 切换到 **Settings** 选项卡。
    3. 在 **Key-based Integration** 中，打开下拉菜单并选择 **CometAPI**。
    4. 点击右上角蓝色的 **Save** 按钮。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360713.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=ceea3b9fec0cf8a1ab81f70547b0a499" alt="Node Editor 的 Settings 选项卡中，Key-based Integration 已设置为 CometAPI" width="1895" height="923" data-path="images/integrations/810968_360713.png" />
    </Frame>
  </Step>

  <Step title="将你的 API key 添加到节点">
    1. 在 Node Editor 中，切换到 **Inputs** 选项卡（或直接点击节点）。
    2. 点击节点右上角的 🔑 key 图标以打开 key 下拉菜单。
    3. 选择 **+ Bring your own Key**。
    4. 输入一个 **Key ID**（例如 `cometapi-key-1`），并将你的 CometAPI API key 粘贴到 **Value** 中。
    5. 点击 **Save**。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360715.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=25c09a874e2a0ceadf2a83e1192323ca" alt="已填写 Key ID 和 Value 字段的 key 管理对话框" width="1710" height="920" data-path="images/integrations/810968_360715.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360714.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=7a946cdb3d110605b3a9f1d7d91e022b" alt="显示 key 已成功绑定的节点" width="611" height="318" data-path="images/integrations/810968_360714.png" />
    </Frame>
  </Step>

  <Step title="配置输入参数">
    在节点的 **Inputs** 选项卡中：

    * **Instructions**（可选）：设置 system role，例如 `You are a productivity assistant.`
    * **Prompt**：点击 **`</>`** 图标，然后选择 **Trigger → Body → prompt** 以映射传入的请求体。
    * **Advanced → Model**：输入你想使用的当前 model ID。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360716.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=71431b9496c396bbe5fa8d529ca57b27" alt="已配置 Instructions、Prompt 和 Model 的 CometAPI 节点" width="1895" height="940" data-path="images/integrations/810968_360716.png" />
    </Frame>
  </Step>

  <Step title="添加 Return Response 节点并测试">
    1. 在 CometAPI 节点下方，点击 **+ Add a new step** 并选择 **Return Response**。
    2. 在 **Body** 字段中，点击 **`</>`** 并从 CometAPI Text Generator 节点中选择 `response` 变量。
    3. 点击右上角的 **Test**，选择 **JSON** 输入格式，并发送：

    ```json theme={null}
    {
      "prompt": "hi"
    }
    ```

    4. **Result** 面板中返回成功响应，即表示工作流运行正常。

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360717.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=561ea8bcdfd96a014dab4476840ee377" alt="显示 CometAPI 成功响应的 BuildShip 测试面板" width="1885" height="934" data-path="images/integrations/810968_360717.png" />
    </Frame>

    如果调用失败，请检查你的 API key，并确认 Key-based Integration 已设置为 **CometAPI**，或者联系 [CometAPI 支持](https://www.cometapi.com)。
  </Step>
</Steps>

<Tip>
  **Key-based Integration** 步骤（将节点关联到 CometAPI）至关重要——即使你的 API key 正确，跳过它也会导致身份验证错误。
</Tip>

<script type="application/ld+json">
  {`
    {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "HowTo",
        "@id": "https://apidoc.cometapi.com/integrations/buildship#howto",
        "name": "将 BuildShip 连接到 CometAPI",
        "description": "使用本指南，通过设置 base URL、API key 以及 model 或 provider 选项，将 BuildShip 连接到 CometAPI。",
        "step": [
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-1",
            "position": 1,
            "name": "获取你的 CometAPI API key",
            "text": "创建或打开你的 CometAPI 账户，然后从控制台复制一个有效的 API key。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-2",
            "position": 2,
            "name": "创建一个带有 REST API 触发器的工作流",
            "text": "完成“将 BuildShip 连接到 CometAPI”指南中的“创建一个带有 REST API 触发器的工作流”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-3",
            "position": 3,
            "name": "添加 CometAPI Text Generator 节点",
            "text": "完成“将 BuildShip 连接到 CometAPI”指南中的“添加 CometAPI Text Generator 节点”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-4",
            "position": 4,
            "name": "关联 CometAPI 集成",
            "text": "完成“将 BuildShip 连接到 CometAPI”指南中的“关联 CometAPI 集成”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-5",
            "position": 5,
            "name": "将你的 API key 添加到节点",
            "text": "完成“将 BuildShip 连接到 CometAPI”指南中的“将你的 API key 添加到节点”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-6",
            "position": 6,
            "name": "配置输入参数",
            "text": "完成“将 BuildShip 连接到 CometAPI”指南中的“配置输入参数”步骤。"
          },
          {
            "@type": "HowToStep",
            "@id": "https://apidoc.cometapi.com/integrations/buildship#step-7",
            "position": 7,
            "name": "添加 Return Response 节点并测试",
            "text": "完成“将 BuildShip 连接到 CometAPI”指南中的“添加 Return Response 节点并测试”步骤。"
          }
        ]
      },
      {
        "@type": "BreadcrumbList",
        "itemListElement": [
          {
            "@type": "ListItem",
            "position": 1,
            "name": "CometAPI 文档",
            "item": "https://apidoc.cometapi.com/"
          },
          {
            "@type": "ListItem",
            "position": 2,
            "name": "集成",
            "item": "https://apidoc.cometapi.com/integrations"
          },
          {
            "@type": "ListItem",
            "position": 3,
            "name": "将 BuildShip 连接到 CometAPI",
            "item": "https://apidoc.cometapi.com/integrations/buildship"
          }
        ]
      }
    ]
    }
    `}
</script>
