跳到主要内容

API库

API库用于接入外部系统接口,并将其注册为AI可调用的工具能力


一、功能概述

API库 用于统一管理外部系统接口(如ERP、CRM、OA等),并支持将接口转换为工具,供AI在执行任务时调用。

通过API库,可以实现AI对业务系统的数据读取、写入和操作。

二、核心作用

API库主要用于:

  • 接入外部系统接口
  • 管理接口信息
  • 测试接口调用
  • 将接口注册为工具供AI使用

三、页面结构说明

API库 进入页面,整体分为两个区域:

1. 连接器应用(左侧)

展示某平台已接入的系统应用,例如:

  • SAP
  • 企业微信
  • 钉钉

每个应用下包含多个API接口。

2. API列表(右侧)

展示当前应用下的接口信息,包括:

  • API名称
  • 请求方式(GET / POST)
  • API Code
  • 注册状态

支持操作:

四、核心功能说明

1. 查看接口详情

点击 查看详情 可查看:

  • 请求参数
  • API Code
  • 工具名

同时支持点击 测试执行,用于验证接口调用是否正常:

2. 注册为工具

步骤一:选择平台

在页面右上角选择已经连接的平台

步骤二:选择应用

在左侧选择目标连接器(如 SAP)

步骤三:选择接口

在右侧找到需要使用的API

步骤四:注册

点击 注册为工具 后:

→ 接口将转换为工具
→ 自动同步至 工具库

注册后,AI即可调用该接口。

3. 取消注册

点击 取消注册 后:

→ 工具将从工具库中移除
→ AI将无法再调用该接口

4. 重新注册

用于以下场景:

  • 接口配置发生变更
  • 需要同步最新接口信息

五、工作机制

API工具的调用流程如下:

用户提问

技能(Skill)

调用工具(API工具)

请求外部系统接口

返回数据

说明

  • API库负责接口接入
  • 工具库负责工具调用
  • 技能负责业务逻辑

六、使用场景

场景1:数据查询

  • 例如:
    • 查询订单信息
    • 查询用户数据

场景2:数据写入

  • 例如:
    • 新增业务数据
    • 提交表单

场景3:系统操作

  • 例如:
    • 修改状态
    • 删除记录

七、常见问题

1. 注册后工具未出现

  • 可能原因
    • 工具库未刷新
    • 注册失败
  • 建议
    • 检查注册状态
    • 刷新工具库

2. 接口调用失败

  • 可能原因
    • 参数错误
    • 权限不足
    • 接口异常
  • 建议
    • 查看接口详情
    • 检查参数配置

八、使用建议

  • 接口命名建议清晰规范(如:查询/新增/修改/删除)
  • 一个接口只做一件事情,避免复杂逻辑
  • 优先注册核心业务接口,避免工具过多

九、相关模块