智能体信息查询

接口信息

接口地址:/api/v1/agent

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数

请求头

参数名	类型	必填	描述	示例值
Authorization	string	是	API Key	Bearer ak-xxxxeyJhbGciOiJIUzI1NiJ9

响应参数:

参数名称	参数说明	类型	schema
code	业务状态码，0000 表示成功，其余失败	string
displayCode	源系统状态码，用于问题跟踪	string
message	错误描述信息	string
data
spaceId	智能体所属的空间ID	integer(int64)
agentId	智能体ID	integer(int64)
name	智能体名称	string
description	智能体介绍信息	string
icon	图标	string
remark	发布备注信息	string
publishDate	智能体发布时间	string(date-time)
statistics	统计信息(智能体、插件、工作流相关的统计都在该结构里，根据实际情况取值)
targetId		integer
userCount	用户人数	integer
convCount	会话次数	integer
collectCount	收藏次数	integer
likeCount	点赞次数	integer
publishUser	发布者信息
userId	用户ID	integer
userName	用户名	string
nickName	昵称	string
avatar	头像	string
category	智能体分类名称	string
openSuggest	是否开启问题建议,可用值:Open,Close	string
openingChatMsg	开场白文案	string
openingGuidQuestions	引导问题	array	string
openScheduledTask	是否开启定时任务,可用值:Open,Close	string
variables	参数	array	Arg
key	参数key，唯一标识，不需要前端传递，后台根据配置自动生成	string
name	参数名称，符合函数命名规则	string
displayName	参数展示名称，供前端展示使用	string
description	参数详细描述信息	string
require	是否必须	boolean
inputType	输入类型, 单行文本 Text, 多行段落 Paragraph, 下拉单选 Select,下拉多选 MultipleSelect, 数字 Number, 智能识别 AutoRecognition	string
selectConfig	下拉参数配置	SelectConfig	SelectConfig
shareLink	分享链接	string
manualComponents	可手动选择的组件列表	array
id	组件ID	integer
name	组件名称	string
icon	组件图标	string
description	组件描述	string
type	组件类型,可用值:Plugin,Workflow	string
defaultSelected	是否默认选中，0-否，1-是	integer
allowCopy	是否允许复制, 1 允许	integer(int32)
collect		boolean
tid	跟踪唯一标识	string
success		boolean

响应示例:

{
	"code": "0000",
	"displayCode": "0000",
	"message": "",
	"data": {
		"spaceId": 0,
		"agentId": 0,
		"name": "",
		"description": "",
		"icon": "",
		"remark": "",
		"publishDate": "",
		"statistics": {
			"targetId": 0,
			"userCount": 0,
			"convCount": 0,
			"collectCount": 0,
			"likeCount": 0,
			"referenceCount": 0,
			"callCount": 0,
			"failCallCount": 0,
			"totalCallDuration": 0
		},
		"publishUser": {
			"userId": 0,
			"userName": "",
			"nickName": "",
			"avatar": ""
		},
		"category": "",
		"openSuggest": "",
		"openingChatMsg": "",
		"openingGuidQuestions": [],
		"openScheduledTask": "",
		"variables": [
			{
				"key": "",
				"name": "",
				"displayName": "",
				"description": "",
				"dataType": "",
				"require": true,
				"enable": true,
				"systemVariable": true,
				"bindValueType": "",
				"bindValue": "",
				"inputType": "",
				"selectConfig": {}
			}
		],
		"shareLink": "",
		"manualComponents": [
			{
				"id": 0,
				"name": "",
				"icon": "",
				"description": "",
				"type": "",
				"defaultSelected": 0
			}
		],
		"allowCopy": 0,
		"collect": true
	},
	"tid": "",
	"success": true
}