腾讯云智能体开发平台接入 API 插件

插件可以为智能体应用添加额外的能力，支持开发者自定义插件功能。您可以参考以下步骤创建插件：
1. 填写插件基本信息
点击腾讯云智能体开发平台左侧菜单的插件广场 > 创建插件。
1.1 填写插件基本信息
填写插件基本信息，包括名称、上传插件图标。
﻿
﻿
﻿
1.2 指定创建方式
您可以通过以下两种方式创建智能体：
基于服务创建：手动填写 API 的基础信息、输入和输出参数。
基于代码创建：使用 Python 自定义函数代码以实现 API 功能。
1.3 指定插件授权方式
根据工具 API 的实际鉴权要求，在授权方式处选择“无需授权”或“API Key”。
﻿
﻿
﻿
2. 配置工具
您可以通过手动添加工具或添加 yaml/json 格式代码文件导入 API 工具。以手动添加工具为例，在“添加工具（API）”步骤中填写工具名称、调用地址等信息，配置接口对应的入参和出参后完成配置。
﻿
﻿
﻿
您可以通过不同类型的代码格式导入插件。以下是不同规范的 API 接入说明和示例：
OpenAPI
OpenAPI 是一种开放的规范，用于描述和定义 RESTful API 的接口。它允许开发者以标准化的方式描述 API 的请求、响应、参数、认证等信息。
文件格式：支持 YAML 格式和 JSON 格式。
关键字段说明：
字段
说明
是否必需
openapi
规范版本号，如3.0.0
是
servers
定义 API 的基础 URL 列表
否，但建议填写以生成有效 URL
info
API 元数据，包括标题、版本、描述等
是
paths
定义所有端点（如 /users）及其 HTTP 方法（GET/POST）
是
components
存储可复用的模型、参数、响应等，如 schemas 定义数据结构
否
示例：
YAML
JSON
openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
  description: 示例 OpenAPI 文档，包含基础服务器配置
servers:
  - url: "https://example.com/api"
    description: "生产环境 API 服务器"
  - url: "https://sandbox.example.com/api"
    description: "测试环境 API 服务器"
paths:
  /users:
    # GET 请求示例
    get:
      summary: 获取所有用户
      responses:
        '200':
          description: 成功返回用户列表
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
    # POST 请求示例
    post:
      summary: 创建新用户
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: 用户创建成功
components:
  schemas:
    User:
      type: object
      required:
        - name
      properties:
        id:
          type: integer
          readOnly: true
          example: 1
        name:
          type: string
          example: "张三"
        email:
          type: string
          format: email
          example: "user@example.com"
{
  "openapi": "3.0.0",
  "info": {
    "title": "User API",
    "version": "1.0.0",
    "description": "示例 OpenAPI 文档，包含基础服务器配置"
  },
  "servers": [
    {
      "url": "https://example.com/api",
      "description": "生产环境 API 服务器"
    },
    {
      "url": "https://sandbox.example.com/api",
      "description": "测试环境 API 服务器"
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "获取所有用户",
        "responses": {
          "200": {
            "description": "成功返回用户列表",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/User"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "创建新用户",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/User"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "用户创建成功"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "User": {
        "type": "object",
        "required": ["name"],
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true,
            "example": 1
          },
          "name": {
            "type": "string",
            "example": "张三"
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "user@example.com"
          }
        }
      }
    }
  }
}
Swagger
Swagger 是 OpenAPI 规范的前身和实现工具（Swagger 2.0 是旧版规范），用于描述、文档化和测试 RESTful API，使用与 OpenAPI 相同的文件格式。
文件格式：支持 YAML 格式和 JSON 格式。
关键字段说明：
字段
说明
是否必需
swagger
规范版本号，如2.0
是
host
域名
否，但建议填写以生成有效 URL
basePath
基础路径
否，但建议填写以生成有效 URL
schemes
支持的协议，如 http 或 https
否，但建议填写以生成有效 URL
info
API 元数据，包括标题、版本、描述等
是
paths
定义所有端点（如 /users）及其 HTTP 方法（GET/POST）
是
definitions
数据模型，相当于 OpenAPI 的 components/schemas
否
示例：
YAML
JSON
swagger: "2.0"
info:
  title: User API
  version: 1.0.0
  description: 示例 Swagger 2.0 文档
host: "example.com"
basePath: "/api"
schemes:
  - "https"
paths:
  /users:
    # GET 请求
    get:
      summary: 获取所有用户
      responses:
        '200':
          description: 成功返回用户列表
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
    # POST 请求
    post:
      summary: 创建新用户
      parameters:
        - in: body
          name: user
          required: true
          schema:
            $ref: '#/definitions/User'
      responses:
        '201':
          description: 用户创建成功
definitions:
  User:
    type: object
    required:
      - name
    properties:
      id:
        type: integer
        readOnly: true
        example: 1
      name:
        type: string
        example: "张三"
      email:
        type: string
        format: email
        example: "user@example.com"
{
  "swagger": "2.0",
  "info": {
    "title": "User API",
    "version": "1.0.0",
    "description": "示例 Swagger 2.0 文档"
  },
  "host": "example.com",
  "basePath": "/api",
  "schemes": ["https"],
  "paths": {
    "/users": {
      "get": {
        "summary": "获取所有用户",
        "responses": {
          "200": {
            "description": "成功返回用户列表",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/User"
              }
            }
          }
        }
      },
      "post": {
        "summary": "创建新用户",
        "parameters": [
          {
            "in": "body",
            "name": "user",
            "required": true,
            "schema": {
              "$ref": "#/definitions/User"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "用户创建成功"
          }
        }
      }
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "required": ["name"],
      "properties": {
        "id": {
          "type": "integer",
          "readOnly": true,
          "example": 1
        },
        "name": {
          "type": "string",
          "example": "张三"
        },
        "email": {
          "type": "string",
          "format": "email",
          "example": "user@example.com"
        }
      }
    }
  }
}
Postman
Postman 是一个 API 开发和测试工具，其 Collection 格式用于保存请求、测试脚本和环境变量，适合手动测试和团队协作。
文件格式：支持 JSON 格式。
关键字段说明：
字段
说明
是否必需
info
集合元数据，包括集合名称和集合版本
是
item
请求列表，每个请求需指定方法和 URL
是
request
请求详情，包括 header, body, auth 等
是
auth
认证配置，如 API Key
否
event
预请求脚本或测试脚本
否
示例：
{
  "info": {
    "name": "User API Collection",
    "version": "1.0.0",
    "description": "示例 Postman 集合，包含 GET 和 POST 请求"
  },
  "item": [
    {
      "name": "用户管理",
      "item": [
        {
          "name": "获取所有用户 (GET)",
          "request": {
            "method": "GET",
            "url": "https://api.example.com/users",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ]
          },
          "response": []
        },
        {
          "name": "创建用户 (POST)",
          "request": {
            "method": "POST",
            "url": "https://api.example.com/users",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\\"name\\": \\"John Doe\\", \\"email\\": \\"john@example.com\\"}"
            }
          },
          "response": []
        }
      ]
    }
  ]
}
3. 校验插件
工具配置完后，进入校验环节。在校验窗口中，填写输入参数后试运行，查看调用结果，测试插件是否能够正常调用。支持将当前测试结果保存为示例。
﻿
﻿
﻿
试运行通过之后，保存当前编辑的插件。
﻿
﻿
﻿
注意：
插件需通过校验后才可保存。
保存后的插件支持在插件广场进行查看、编辑、导出等动作。
﻿
﻿
﻿
4. 使用插件
如需了解如何在应用内使用插件，请参见 使用插件。
﻿
﻿
字段	说明	是否必需
openapi	规范版本号，如3.0.0	是
servers	定义 API 的基础 URL 列表	否，但建议填写以生成有效 URL
info	API 元数据，包括标题、版本、描述等	是
paths	定义所有端点（如 /users）及其 HTTP 方法（GET/POST）	是
components	存储可复用的模型、参数、响应等，如 schemas 定义数据结构	否
接入 API 插件

本页目录：

1. 填写插件基本信息

1.1 填写插件基本信息

1.2 指定创建方式

1.3 指定插件授权方式

2. 配置工具

OpenAPI

Swagger

Postman

3. 校验插件

4. 使用插件
