插件
通过任务插件扩展 New API 的图片、视频、音乐及其他任务能力,了解安装、配置与开发流程。
什么是任务插件
任务插件是运行在 New API 网关内的单文件 JavaScript 模块,用于对接上游的任务提交、结果解析、轮询和产物下载。管理员可以通过插件扩展图片、视频、音乐等生成能力,无需为每个上游重新编译网关。
插件负责把请求和响应转换为统一的数据结构。New API 宿主负责鉴权、渠道选择、HTTP 请求、任务持久化、重试、轮询和计费结算。插件只报告用量事实,不自行决定用户应付的价格。
版本状态
当前插件仓库仍将 Task Plugin API v1
标记为尚未正式发布的契约。本文依据当前插件仓库和 New API
实现编写;安装前请确认你的网关版本支持插件声明的字段和能力,不能仅凭
apiVersion: 1 判断兼容性。
从这里开始
插件市场
搜索官方插件,查看模型、接口、用量和更新日志,复制对应官网的安装地址。
安装与管理
安装插件、导入官网地址、升级或切换已有版本。
渠道与计费
绑定插件渠道,配置模型、分组、密钥和用量价格。
开发插件
从完整的最小示例开始,编写和验证自己的任务插件。
内置插件与自定义版本
| 类型 | 来源 | 管理方式 |
|---|---|---|
| 内置插件(Factory) | 随 New API 程序提供 | 不可单独删除或停用;可由同 key 的自定义版本覆盖 |
| 覆盖版本(Override) | 安装或上传的同 key 插件 | 启用后覆盖内置版本;停用或删除覆盖版本后恢复内置插件 |
| 第三方插件 | 安装或上传的新 key 插件 | 停用或删除后,相应插件能力不可用 |
任务插件总开关控制整个插件系统,包括内置插件。关闭它会立即停止插件服务,进行中的任务随后由超时清理处理。进行升级、停用和删除前,应检查关联渠道及未完成任务。
谁可以使用
- Root(超级管理员):安装、上传、升级、启停、删除、配置市场源和运行调试。
- 具有插件绑定权限的管理员:在渠道管理中选择可用插件并绑定渠道;这不等同于插件管理权限。
- API 用户:使用自己实例的 API 密钥调用已开放的模型和接口,无需拥有插件管理权限。
任务插件扩展的是网关本身。用于 AI 编码助手的扩展见 Skills。
推荐配置顺序
规范与源码
具体插件的版本、支持模型和更新记录以市场实时数据为准。
这篇文档对您有帮助吗?
最后更新于