准备工作

在调用扳手AI平台开放的 API 前,您需要确保已完成以下准备工作:

  1. 发布智能体/技能:只有发布为 API 服务的智能体/技能才能被调用,未发布的智能体/技能无法通过 API 访问。
  2. 获取访问令牌(Token) 可选个人令牌Oauth令牌: 访问令牌(Token)是用于验证调用方身份的关键凭据,可选择使用个人令牌或OAuth令牌。 个人令牌:由用户本人生成并提供,所有进行的操作、权限等都记录于创建个人令牌的用户账号。 OAuth令牌:通过与扳手平台完成单点登录认证后,所登录的账号生成相应的Token,该令牌可用于授权相关操作,所有进行的操作、权限等都记录于当前登录的账号。
  3. 获取应用秘钥(Key):调用 扳手AI API 时,密钥用于标识智能体或技能信息。每个智能体/技能都有独立的密钥。

发布智能体或技能

智能体或技能必须发布为 API 服务,才能通过 API 调用。发布时可选择公开发布私有发布,具体规则如下:

发布方式

  1. 登录扳手AI平台账户,进入我的AI应用
  2. 选中需要发布为 API 的智能体/技能,点击发布选项img.png
  3. 点击页面右上角的发布发布范围按钮。
  4. 根据需求选择公开发布私有发布,并完成相关配置。
  5. 点击发布按钮完成操作。img.png

发布范围

  1. 公开发布

    • 公开发布的智能体/技能可以被指定范围内的用户调用。
    • 发布时需配置以下选项:
      • 角色范围:允许哪些角色访问此智能体/技能(例如所有用户、指定用户组等)。
      • 是否公开配置:决定是否向调用方公开智能体/技能的配置信息。
      • 发布范围:设置智能体/技能的调用权限范围。
    • 配图示例: img.png
  2. 私有发布

    • 私有发布的智能体/技能只能通过拥有特定 Token 的调用方访问。
    • 适用于需要严格限制访问权限的场景。

生成令牌

一、生成个人令牌

  1. 访问生成页面:登录扳手AI主页,进入 AI创作空间-AI智能体,点击任意卡片的调用按钮。 img.png
  2. 选择令牌类型:根据您的需求选择个人令牌。 img.png
  3. 设置权限:选择该令牌需要的权限,例如获取聊天记录、发起聊天等。 img.png
  4. 生成令牌:点击确定按钮,系统将为您提供一个 Token。Token将仅展示一次,请妥善保存该 Token,因为它将用于后续的 API 调用。

二、生成OAuth2客户端密钥

  1. 访问生成页面:登录扳手AI主页,进入 个人中心-授权管理,右上角新增密钥。 img.png
  2. 选择令牌类型:根据您的需求选择Oauth应用。 img.png
  3. 获取应用ID(ClientID)令牌(ClientSecret)重定向地址(redirect_uri):ClientSecret将仅展示一次,请务必妥善保管,ClientID即页面列表展示的应用ID,redirect_uri即为应用链接 img.png

生成应用密钥

  1. 访问生成页面:登录扳手AI主页,进入 AI创作空间-AI智能体,点击任意卡片的调用按钮。 img.png

  2. 选择 应用API-KEY,创建应用密钥(key)img.png

  3. 填写信息,然后点击确定,系统将为您生成一个新的应用密钥(key)。请妥善保存该密钥。 img.png