Skip to content

智能体管理

1. 准备

基础域名https://api.rokid.com

准备

  • 确保已经获取到了有效的 API 密钥(API_KEY),用于身份验证。
  • 确保企业下已经产生智能体调用日志,便于查询返回结果。

2. 功能介绍

智能体管理模块提供了 AI 问答记录的分页查询能力,帮助开发者按用户、时间范围、模板名称、模型名称等条件筛选问答记录,查看问题内容、回答结果、模型信息和调用状态。

2.1 分页查询 AI 问答记录

接口地址:https://api.rokid.com/ar/assistant/openapi/chatLog/page?pageNum={$pageNum}&pageSize={$pageSize}&type={$type}&keywords={$keywords}&uid={$uid}&startTime={$startTime}&endTime={$endTime}&agentName={$agentName}&modelName={$modelName}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述: 分页查询当前企业下的 AI 问答记录

请求参数:

参数名称参数说明是否必须数据类型
pageNum页码,默认值 1falseint
pageSize每页数量,默认值 10falseint
type日志类型:0 聊天,1 识别,默认值 0falseint
keywords关键词,匹配问题内容和回答内容falsestring
uid用户 ID,精确匹配falsestring
startTime开始时间,支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ssfalsestring
endTime结束时间,支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ssfalsestring
agentName模板名称,模糊匹配falsestring
modelName模型名称,模糊匹配falsestring

输出结果:

参数名称参数说明是否必须数据类型
pageNum当前页码trueint
pageSize每页数量trueint
total总记录数truelong
list日志记录列表truearray
id主键 IDtruelong
type日志类型:0 聊天,1 识别trueint
deviceId设备编号falsestring
agentId智能体 IDfalsestring
agentName模板名称falsestring
modelId模型 IDfalsestring
modelName模型名称falsestring
modelApiName模型 API 名称falsestring
systemPrompt系统提示词falsestring
questionContent问题内容falsestring
questionImg问题图片地址falsestring
answerContent回答内容falsestring
costTime耗时,单位毫秒falseint
status调用状态falsestring
errorMsg错误信息falsestring
isMemory是否启用记忆falseboolean
time调用时间falsestring
uid用户 IDfalsestring
userName用户名称falsestring
companyId组织 IDfalsestring
gmtCreated创建时间falsestring
gmtModified更新时间falsestring
deleted是否删除:0 未删除,1 已删除falseint

请求示例:

bash
curl -X GET "https://api.rokid.com/ar/assistant/openapi/chatLog/page?pageNum=1&pageSize=10&type=0&uid=E0BB5354E9F54BC6A032E8B709CC7B2E&startTime=2026-06-01&endTime=2026-06-15%2023:59:59&agentName=%E5%B7%A1%E6%A3%80%E5%8A%A9%E6%89%8B&modelName=gpt" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json"

响应示例:

json
{
  "code": 0,
  "message": "OK",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 1,
    "list": [
      {
        "id": 1001,
        "type": 0,
        "deviceId": "1901092524001715",
        "agentId": "agent_demo_001",
        "agentName": "巡检助手",
        "modelId": "common",
        "modelName": "默认模型",
        "modelApiName": "gpt-4o-mini",
        "systemPrompt": "你是一个巡检助手",
        "questionContent": "请帮我总结今天的巡检结果",
        "questionImg": "",
        "answerContent": "今天共完成 8 个点位巡检,未发现异常。",
        "costTime": 1260,
        "status": "success",
        "errorMsg": "",
        "isMemory": true,
        "time": "2025-11-07T15:20:00.000+08:00",
        "uid": "E0BB5354E9F54BC6A032E8B709CC7B2E",
        "userName": "张三",
        "companyId": "rokid-demo-company",
        "gmtCreated": "2025-11-07T15:20:00.000+08:00",
        "gmtModified": "2025-11-07T15:20:00.000+08:00",
        "deleted": 0
      }
    ]
  },
  "success": true
}