历史会话列表-阿里云帮助中心

本文为您介绍OpenSearch-LLM智能问答版获取历史会话列表API。

前提条件

获取身份鉴权API Key：调用OpenSearch-LLM智能问答版服务时，需要对调用者身份进行鉴权，具体请参见管理API Key。
获取服务调用地址：调用OpenSearch-LLM智能问答版服务时，需要提供服务的调用地址，具体请参见获取服务调用地址。

注意事项

主账号、子账号、API Key三个维度之间的历史会话数据完全隔离，不同身份主体及鉴权方式之间的会话数据不共享。

接口信息

请求方法	请求协议	请求数据格式
GET	HTTP	JSON

请求URL

{host}/v3/openapi/apps/{app_group_identity}/chat-history?page_number=1&page_size=10

{host}：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务调用地址。
{app_group_identity}：应用名称，需要登录OpenSearch-LLM智能问答版控制台，在实例管理中查看对应实例的应用名称。

请求参数

Header参数

参数	类型	是否必填	描述	示例值
Content-Type	string	是	请求的数据格式，目前仅支持JSON格式，固定填写"application/json"。	application/json
Authorization	string	是	请求鉴权的API Key，Bearer开头。	Bearer OS-d1**2a

Body参数

参数	类型	是否必填	描述	示例值
page_number	integer	否	起始页。	1
page_size	integer	否	每页条数。（默认10，最大20）	10

请求体示例

curl -X GET "{host}/v3/openapi/apps/{app_group_identity}/chat-history?page_number=1&page_size=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {API Key}"

返回参数

参数	类型	描述
request_id	string	请求ID。
result	Map	结果数据。
result.latency	float	请求成功时接口耗时，单位为毫秒。
result.total_count	integer	数据总条数。
result.data	list	返回数据。
result.data[0].title	string	会话标题。
result.data[0].chat_id	string	会话id。
result.data[0].status	string	会话或者任务状态。
result.data[0].time	string	会话开始时间。
code	string	返回的错误码（若无报错则不返回）。
message	string	返回的错误信息（若无报错则不返回）。

响应体示例

{
  "request_id": "a842*******************133b",
  "status": "OK",
  "total_count": 1,
  "latency": 0,
  "result": [
    {
      "chat_id": "1751622286901",
      "title": "为我推荐一张周杰伦的专辑",
      "time": "2025-07-04 21:38:06",
      "status": "SUCCESS"
    }
  ],
  "errors": []
}