# 零代码应用操作指南

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

零代码应用产品面向非编程人员用户，支持通过可视化界面来创建智能应用，以及根据需要为应用添加开箱即用的基础插件，从而降低应用开发门槛。关于该产品的更多介绍，请参见[零代码应用简介](/docs/no-code-app-overview)。本文介绍如何创建和管理零代码应用。

---

<span id="9d6e3f71"></span>
# 准备工作

<span id="ae72c2f1"></span>
## 创建自定义推理接入点

零代码应用需要通过推理接入点来调用模型。

* 限制：

    * 对于单聊应用，可以直接使用预置推理接入点，也可以使用自定义推理接入点。
    * 对于群聊应用，只能使用自定义推理接入点。
* 计费：每个模型赠送 500,000 token 免费额度，超出部分按 token 使用量付费，详见[模型服务计费说明](/docs/model-service-pricing)。

如需创建自定义推理接入点，请按照以下步骤操作。详细步骤参见[获取 Endpoint ID（创建自定义推理接入点）](https://ark.volcengine.com/region:cn-beijing/docs/create-standard-inference-endpoint)。

1. 在方舟控制台打开 [在线推理](https://ark.volcengine.com/region:cn-beijing/endpoint) 页面。
2. 在**自定义推理接入点**标签页上点击**创建推理接入点**。
3. 完成信息配置，包括接入点名称、接入点描述、推理模式、接入模型等，然后在页面右下角点击**创建并接入**。

<span id="77eea967"></span>
## **[可选]** 开通插件

根据业务需求选择特定插件功能，与大模型组合串联，灵活搭建智能体应用。
限制：仅单聊应用支持使用插件，群聊应用不支持。

| **插件** | **用途** | **限制** | **计费** |
| --- | --- | --- | --- |
| 网页解析 | 可解析 URL 链接下的标题和内容，支持网页、PDF、抖音视频等内容的提取与检索。 | 该插件当前仅支持单独使用，添加后将自动关闭其他插件。 | 插件限时免费，但使用插件可能会让模型产生更多的 token 消耗。 |
| 联网内容插件 | 用于联网搜索相关内容。 | 开启此插件时，Function Calling 功能不生效。 | 零代码应用使用联网内容插件的计费包括以下部分： | \
| | | | | \
| | | | * 内容资源使用次数，详见[联网内容插件产品计费](/docs/online-content-plugin-pricing)。 | \
| | | | * 模型 token 消耗费用。零代码联网链路包含意图识别、问题改写、总结环节。您可在零代码应用的创建或编辑页面上，通过**联网内容插件**＞**联网高级配置**面板来启用或禁用对应环节；若启用，则各环节将产生一定的模型 token 消耗，并按照真实的输入输出按量计费。 |
| 知识库插件 | 为零代码应用提供更丰富的内容支持。 | 开启此插件时，Function Calling 功能不生效。 | 零代码应用使用知识库插件的计费包括以下部分： | \
| | | | | \
| | | | * 知识库费用，详见[知识库计费](/docs/knowledge-base-pricing)。 | \
| | | | * 模型 token 消耗费用。若启用，则从知识库搜索到的内容将被作为输入的一部分送入大模型，因此会消费更多 token。 |

如需开通插件，请按以下步骤操作：

1. 在方舟控制台打开 [应用组件库](https://ark.volcengine.com/region:cn-beijing/openManagement?action=%7B%7D&advancedActiveKey=component) 页面。
2. 在相应插件的**操作**栏中点击**开通**。

    ![tab_app_components.png](https://arkdocs.tos-cn-beijing.volces.com/images/app/tab_app_components.png)

> **说明**
>
> 若选择开通知识库组件，则还需要创建知识库才能发挥知识库插件的作用，操作步骤参见 [创建知识库](https://docs.volcengine.com/docs/vector_database_vikingdb/creatingaknowledgebase?lang=zh)。

---

<span id="02a08872"></span>
# 创建单聊应用

创建零代码应用之前，先完成以下准备工作，可以让创建过程更加顺利。

1. 在方舟控制台打开 [我的应用](https://ark.volcengine.com/region:cn-beijing/assistant) 页面。
2. 点击**创建应用**，在**创建应用**对话框中选择**零代码**，并点击**创建**。
3. 在**请选择应用类型**对话框中选择**单聊**，并点击**创建**。
4. 在**新建应用**页面上配置以下信息。

    |**配置项** |**是否必选** |**说明** |
    |---|---|---|
    |**基本信息** |||
    |名称 |是 |自定义的应用名称。只可包含中文、英文、数字、下划线（`_`）和短横线（`-`）。 | \
    | | |示例：`我的营养师` |
    |描述 |否 |自定义的应用描述。 | \
    | | |示例：`提供专业营养建议，为您的健康保驾护航。` |
    |封面 |否 |应用的封面图片。支持 .jpg、.png 等常用图片格式。 | \
    | | |示例：`icon.png` |
    |**配置信息** |||
    |推理接入点 |是 |选择一个预置推理接入点或自定义推理接入点。 | \
    | | | | \
    | | |:::tip | \
    | | |* 当前仅支持 Doubao 系列和 DeepSeek 系列的部分模型，具体支持情况以控制台显示为准。建议使用 Pro 模型，效果更好。 | \
    | | |* 是否可以使用联网内容插件、知识库插件和其他插件，取决于具体的模型，以控制台显示为准。 | \
    | | |::: |
    |联网内容插件 |否 |若启用，则联网搜索到的内容将被作为输入的一部分送入大模型，因此会消费更多 token，请合理设置联网内容插件参数。 | \
    | | | | \
    | | |* 基础配置：您可以选择搜索的内容源与引用条数。 | \
    | | |* 高级配置：展开**高级配置**后，可配置高级选项，例如智能改写、调用方式、参考资料回复、最大参考资料 token 数等。详见控制台说明及示例。 |
    |知识库插件 |否 |若启用，则从知识库搜索到的内容将被作为输入的一部分送入大模型，因此会消费更多 token，请合理设置知识库插件参数。 | \
    | | | | \
    | | |* 基础配置：您可以选择已创建的知识库，设置引用条数，并选择是否开启模型重排。此外，点击**检索测试**即可跳转至知识库页面进行检索测试，查看知识库的命中效果。 | \
    | | |* 高级配置：展开**高级配置**后，可配置高级选项，例如智能改写、调用方式、Dense Weight、参考资料回复、来源显示等。详见控制台说明及示例。 |
    |Trace 服务 |否 |若开启，将自动采集您请求的 Input 和 Output 及各阶段耗时信息，并记录在日志服务中，便于后续运维和排查。该服务限时免费。 |
    |更多插件 |否 |可选择添加计算器和网页解析插件。 |
    |**提示词 System Prompt** |||
    |提示词设置 |否 |配置 System Prompt，例如设定应用的行为和背景，告知应用需要扮演的角色。 | \
    | | |示例： | \
    | | | | \
    | | |```Plain Text | \
    | | |您是专业、亲切、靠谱的注册营养师，可联网搜索权威营养数据、膳食指南、食物成分，给出科学、安全、可落地的饮食建议。 | \
    | | |## 角色要求 | \
    | | |- 专业严谨：基于营养学、权威指南回答，不造谣、不玄学。 | \
    | | |- 亲切友好：语气温柔耐心，可使用少量表情符号 😊🥗🍎，轻松不生硬。 | \
    | | |- 实用落地：提供日常可执行的饮食方案，不极端、不制造焦虑。 | \
    | | |## 工作内容 | \
    | | |- 解答营养问题：食物营养、热量、三餐搭配、减脂 / 增肌饮食、食材选择、常见饮食误区等。 | \
    | | |- 可根据身高、体重、年龄、目标给出个性化营养建议。 | \
    | | |## 禁止行为 | \
    | | |- 不诊断疾病、不开处方、不替代医生。 | \
    | | |- 不推荐减肥药、保健品、三无产品。 | \
    | | |- 不提倡极端节食、断食、伪科学饮食法。 | \
    | | |``` |
    |**开场白** |||
    |开场白 |否 |应用与用户打招呼的第一句话。这句话不会消费 token。 | \
    | | |示例：`您好！我是您的营养师。` |
    |开场问题 |否 |帮用户预设好的问题，用户只需要点击即可直接提出问题。 | \
    | | |示例：`有什么建议的早餐食谱吗？` |

5. 配置完毕后，在页面右上角点击**发布**。

> **说明**
>
> 初次发布成功后，如果修改了应用设置，则需要点击页面右上角的**更新**来使更改生效。

---

<span id="0782a44f"></span>
# 创建群聊应用

1. 在方舟控制台打开 [我的应用](https://ark.volcengine.com/region:cn-beijing/assistant) 页面。
2. 点击**创建应用**，在**创建应用**对话框中选择**零代码**，并点击**创建**。
3. 在**请选择应用类型**对话框中选择**群聊**，并点击**创建**。
4. 在**新建应用**页面上配置以下信息。

> **说明**
>
> 群聊应用不支持使用插件。

    |**配置项** |**是否必选** |**说明** |
    | --- | --- | --- |
    |**基本信息** |  |  |
    |名称 |是 |自定义的应用名称。只可包含中文、英文、数字、下划线（_）和短横线（-）。 | \
    | | |示例：`团建策划群` |
    |描述 |否 |自定义的应用描述。 | \
    | | |示例：`团建活动创意头脑风暴` |
    |封面 |否 |应用的封面图片。支持 .jpg、.png 等常用图片格式。 | \
    | | |示例：`icon.png` |
    |**配置信息** |  |  |
    |用户 |否 |设置**用户角色名**，即用户在对话中显示的名称。 |
    |角色 |否 |可添加多个角色。需要为每个角色设置以下信息： | \
    | | | | \
    | | |* 模型接入点：可选择自定义推理接入点。 | \
    | | |* 角色描述：描述角色的信息，例如性格特点、行为和背景等。详见控制台示例。 | \
    | | | | \
    | | |:::tip | \
    | | |建议至少配置一个角色，若删除所有角色，则无法在控制台上在线调试和预览。 | \
    | | |::: |
    |开场白 |否 |该角色参与对话时说的第一句话。 | \
    | | |示例：`我有个点子～` |
    |**场景设定** |  |  |
    |场景设定 |否 |描述多角色群聊的场景，可设定群聊的主题、时间地点、事件场景、用户扮演的角色等。详见控制台示例。 |

5. 配置完毕后，在页面右上角点击**发布**。

> **说明**
>
> 初次发布成功后，如果修改了应用设置，则需要点击页面右上角的**更新**来使更改生效。

---

<span id="a4bd601b"></span>
# 复制应用

除了从零开始创建应用，如果您此前已经创建过应用，那么也可以选择复制一个现有的应用，并在此基础上修改和调整。

1. 在方舟控制台打开 [我的应用](https://ark.volcengine.com/region:cn-beijing/assistant) 页面。
2. 将鼠标指针悬停在需要复制的应用卡片上，并点击**立即体验**。
3. 在体验页面顶部的应用信息区域，点击**复制**，即可直接进入新建应用页面，并修改应用配置。

    ![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/5e41815d92454191a9835d6f87dc02bb~tplv-goo7wpa0wc-image.image)

---

<span id="2-2-agent-create"></span>
# 预览应用

发布应用后，可以在右侧的预览与调试面板上预览应用的使用效果，并根据需要随时调整应用设置。

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/6fdd28fe16f6423eb47d791afd9c2763~tplv-goo7wpa0wc-image.image)

---

<span id="62f8b604"></span>
# 调试应用

您可以通过调试面板查看会话或插件的执行细节，定位应用响应不符合预期的原因，并针对性地优化应用配置。

<span id="0c0750ae"></span>
## 前提条件

要使用调试功能，您需要在应用设置中打开 **Trace 服务**，详见创建应用的步骤说明。

<span id="83144abc"></span>
## 单次请求调试

在应用编辑页面的**预览与调试**面板上，点击右上角的**调试**，即可打开调试面板。

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/b93637f1bc204013bf4fbfad2f2d76e9~tplv-goo7wpa0wc-image.image)

<span id="849f3bb5"></span>
## 查看调用统计和 Trace 列表

在应用编辑页面顶部点击**分析**标签页，即可查看该应用最多 14 天内的调用量统计和所有 Trace 的详情。

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/a7b80abd26ea4e0bb70d09a73fe8a8de~tplv-goo7wpa0wc-image.image)

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/ece41ad116734fdf83be2734735d24e0~tplv-goo7wpa0wc-image.image)

---

<span id="2-4-api-invocation"></span>
# BotAPI 调用

零代码应用支持通过 API 调用。

> **说明**
>
> 已发布的存量零代码应用仍可继续通过 Bot API 调用。应用实验室后续会下线新建零代码应用入口，具体时间以后续公告为准；入口下线后，将无法再创建新的零代码应用。如果您准备新建生产级 Agent，或希望使用沙箱执行、MCP、记忆存储、多智能体协作等能力，建议迁移到 Managed Agents。迁移方法参见[将零代码应用迁移至 Managed Agents](/docs/migrate-from-bot-api)。

<span id="92afb605"></span>
## 获取示例代码

在应用编辑页面或应用体验页面右上角点击 API 调用指南，可查看完整的说明。

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/181dde51336a4194b78904c7103a9165~tplv-goo7wpa0wc-image.image)

<span id="165ffcfd"></span>
## 调用步骤示例

以下以 Postman 接口测试工具为例介绍 BotAPI 的调用与测试。

> **说明**
>
> 以下测试中使用的值可以从 API 调用指南面板上的 curl 示例代码中复制。API Key 的创建与获取方式，参见[快速入门](/docs/quick-start)。

1. 在 Postman 中创建一个新请求。
2. 将 HTTP 请求方式设为 `POST`，并在请求 URL 文本框中填入示例代码中的 URL。

    ```Plaintext
    https://ark.cn-beijing.volces.com/api/v3/bots/chat/completions
    ```

3. 点击 **Headers** 标签页，并添加以下 Key 和 Value：

    * Authorization: Bearer `<your_api_key>`
    * Content-Type: application/json

    ![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/b8fa8b2423cc4133a73c42aef33e7b6c~tplv-goo7wpa0wc-image.image)

4. 点击 **Body** 标签页，在格式区域选择 **raw**，并将示例代码中的 JSON 数据复制到文本框中，然后点击 **Send**。

> **说明**
>
> 您可以根据测试需要修改 content 的值，替换为您的测试内容。为了方便观察返回结果，建议将 `stream` 参数设置为 `false`，这样可以直接获取完整的返回信息而不是流式输出。

    ![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/7f0e4c57c8a54e8ba43957dc195d12ac~tplv-goo7wpa0wc-image.image)

<span id="aed0b878"></span>
## 参考文档

* [获取 API Key 并配置](/docs/api-key)
* [安装及升级 SDK](/docs/install-and-upgrade-sdk)