教程：基于 API 创建一个插件
输入“/”快速插入内容
教程：基于 API 创建一个插件
教程：基于 API 创建一个插件
背景信息
在扣子中，一个插件可包含多个工具。插件与工具的关系就是 API 服务与 API endpoint 的关系。在创建插件时，首先需要将这个 API 服务注册为一个插件，然后再将这个服务下的 API endpoint 添加到插件中作为工具使用，最后将插件发布上线。
本教程以火山引擎边缘智能产品的列出数据流事件 (ListMediapipeEvent) API 为例，展示如何一步步创建一个插件。以下是这个接口的基本信息。
API 信息 | 说明 |
请求地址 | |
Header | • X-Use-Volcengine：固定值为 1。 • X-Volcengine-Access-key：调用该接口的 Access Key ID。 • X-Volcengine-Secret-key：调用该接口使用的 Secret Access Key。 • Service：服务代码，固定值vei_api。 • Region: 火山引擎 API 支持的地域。本教程的 API 使用 cn-beijing。 • Version：API 版本。本教程使用2022-01-01。 |
接口（Endpoint） | ListMediapipeEvent |
请求参数和返回参数 |
准备工作
在开始前，确保你已经：
•
•
步骤一：创建插件
参考以下操作将上述接口导入为一个插件。
1.
2.
选择一个工作空间，然后单击插件，再单击创建插件。
3.
完成插件基础信息配置：
a.
输入插件名称和描述。
b.
插件工具创建方式选择基于已有服务创建。
4.
5.
将以下 Header 信息配置到 Header 列表中。
◦
X-Use-Volcengine：固定值为 1。
◦
X-Volcengine-Access-key：调用该接口的 AccessKey。
◦
X-Volcengine-Secret-key：调用该接口使用的 Secret Access Key。
◦
Service：服务代码，固定值vei_api。