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

获取对话列表

功能介绍

获取对话列表。

URI

GET /v1/{project_id}/chats

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

限制量，单次查询总量。

约束限制：

不涉及

取值范围：

取值范围[1,1000]。

默认取值：

100

offset

否

Integer

参数解释：

偏移量，查询起始偏移。

约束限制：

不涉及

取值范围：

取值范围[0,100000000]。

默认取值：

0

sort_dir

否

String

参数解释：

排序规则。

约束限制：

不涉及

取值范围：

  • DESC：降序。

  • ASC：升序。

默认取值：

DESC

title

否

String

参数解释：

对话名称，支持模糊搜索。

约束限制：

不涉及

取值范围：

取值范围为[1-500]个字符。

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

chats

Array of ChatRsp objects

参数解释：

对话列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

count

Integer

参数解释：

对话个数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 ChatRsp

参数

参数类型

描述

id

String

参数解释：

对话ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

title

String

参数解释：

对话名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

alias

String

参数解释：

对话别名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

creator

String

参数解释：

对话创建者。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_time

String

参数解释：

创建对话时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

update_time

String

参数解释：

更新对话时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

top_time

String

参数解释：

置顶对话时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

获取对话列表。

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

响应示例

状态码：200

OK

{
  "count" : 1,
  "chats" : [ {
    "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "title" : "demo_title",
    "alias" : "demo_alias",
    "creator" : "test",
    "create_time" : "2021-01-30T02:34:36Z",
    "update_time" : "2021-01-30T02:34:36Z",
    "top_time" : "2021-01-30T02:34:36Z"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档