Skip to main content
GET
/
sessions
List sessions for an agent
curl --request GET \
  --url https://api.example.com/sessions/ \
  --header 'x-user-id: <x-user-id>'
{
  "sessions": [
    {
      "user_id": "<string>",
      "agent_id": "<string>",
      "config": {
        "workspace_id": "<string>",
        "name": "<string>",
        "chat_model_config": {
          "type": "<string>",
          "credential_id": "<string>",
          "model": "<string>",
          "parameters": {}
        }
      },
      "id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "source": "user",
      "source_schedule_id": "<string>",
      "state": {
        "session_id": "<string>",
        "summary": "",
        "context": [
          {
            "name": "<string>",
            "content": [
              {
                "text": "<string>",
                "type": "text",
                "id": "<string>"
              }
            ],
            "id": "<string>",
            "metadata": {},
            "created_at": "<string>",
            "finished_at": "<string>",
            "usage": {
              "input_tokens": 123,
              "output_tokens": 123
            }
          }
        ],
        "reply_id": "<string>",
        "cur_iter": 0,
        "permission_context": {
          "mode": "default",
          "working_directories": {},
          "allow_rules": {},
          "deny_rules": {},
          "ask_rules": {}
        },
        "tool_context": {
          "max_cache_files": 100,
          "max_cache_bytes": 25000,
          "read_file_cache": [
            {
              "lines": [
                "<string>"
              ],
              "updated_at": 123,
              "bytes": 123,
              "file_path": "<string>"
            }
          ],
          "activated_groups": [
            "<string>"
          ]
        },
        "tasks_context": {
          "tasks": [
            {
              "subject": "<string>",
              "description": "<string>",
              "metadata": {},
              "created_at": "<string>",
              "state": "pending",
              "id": "<string>",
              "owner": "<string>",
              "blocks": [
                "<string>"
              ],
              "blocked_by": [
                "<string>"
              ]
            }
          ]
        }
      }
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.agentscope.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Query Parameters

agent_id
string
required

Filter sessions by agent ID.

Response

Successful Response

Response body for listing sessions.

sessions
SessionRecord · object[]
required

Session records.

total
integer
required

Total number of sessions.