List Sessions

Lists sessions with pagination, sorted by created_at in descending order. Supports filtering by agent, status, and creation time range.

Prerequisites

Endpoint and authentication configuration must be completed. For details, see Overview and authentication.

Endpoint

GET /sessions

Query parameters

Request example

curl "$AGENTSTUDIO_URL/sessions?agent_id=agent_xxx&statuses[]=idle&limit=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

for session in client.sessions.list(
    limit=20,
    agent_id="agent_xxx",
    statuses=["idle"],
):
    print(session.id, session.status, session.title)

CursorPage<Session> page = client.sessions().list(SessionListParam.builder()
    .limit(20)
    .agentId("agent_xxx")
    .statuses(Arrays.asList("idle"))
    .build());
for (Session s : page.getData()) {
    System.out.println(s.getId() + " " + s.getStatus() + " " + s.getTitle());
}

Response example

{
  "data": [
    {
      "id": "sesn_xxx",
      "type": "session",
      "status": "idle",
      "stop_reason": null,
      "agent": {
        "id": "agent_xxx",
        "type": "agent",
        "version": 1,
        "name": "data-analyst",
        "model": {"id": "qwen3-max"},
        "system": "你是数据分析专家，使用 pandas 处理 CSV 文件。",
        "tools": []
      },
      "environment_id": "env_xxx",
      "title": "Q3 销售数据分析",
      "metadata": {"biz_ticket_id": "1234"},
      "archived_at": null,
      "created_at": "2026-05-28T08:23:11.456000Z",
      "updated_at": "2026-05-28T08:23:25.789000Z",
      "environment_variables": {"API_BASE_URL": "https://api.example.com", "LOG_LEVEL": "info"}
    }
  ],
  "next_page": "xxx",
  "request_id": "xxx"
}

The response contains data (an array of Session objects) and next_page (cursor for the next page). Session object fields are as follows:

Session object fields