文档首页/ AI科学计算服务/ API参考/ API/ 科研助手/ 科研助手管理/ 获取助手列表 - ListAgent
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

获取助手列表 - ListAgent

功能介绍

获取助手列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/agents

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，您可以从获取项目ID中获取。

约束限制：

不涉及

取值范围：

仅支持字母、数字、中划线和下划线，长度为[1-128]个字符。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制：

不涉及

取值范围：

长度为[1-32768]个字符。

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

agents

Array of AssistantAgent objects

参数解释：

助手列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

count

Integer

参数解释：

助手个数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 AssistantAgent

参数

参数类型

描述

name

String

参数解释：

助手名称。

约束限制：

不涉及

取值范围：

  • auto：通用助手

  • drug：药物助手

  • gene：基因助手

默认取值：

不涉及

models

Array of AssistantModelInfo objects

参数解释：

助手关联的模型列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 AssistantModelInfo

参数

参数类型

描述

model_name

String

参数解释：

模型名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

model_id

String

参数解释：

模型ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

model_type

String

参数解释：

模型类型。

约束限制：

不涉及

取值范围：

  • CHAT：文本对话模型

  • EMBEDDING：嵌入式模型

默认取值：

不涉及

请求示例

获取助手列表。

https://{endpoint}/v1/{project_id}/agents

响应示例

状态码：200

OK

{
  "count" : 1,
  "agents" : [ {
    "name" : "auto",
    "models" : [ {
      "mode_name" : "deepseek",
      "model_id" : "model_id",
      "model_type" : "CHAT"
    } ]
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 科研助手管理

相关文档