Sign in
Agent Sessions

List Sessions

List agent sessions in the namespace.

Args: request: FastAPI request with tenant context list_request: Optional filters and sorting pagination: Pagination parameters

Returns: ListSessionsResponse with session list

Example: bash curl -X POST http://localhost:8000/v1/agents/sessions/list \ -H "Authorization: Bearer {api_key}" \ -H "X-Namespace: {namespace_id}" \ -H "Content-Type: application/json" \ -d '{"status": "active"}'

post/v1/agents/sessions/list

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

status'active' | 'idle' | 'archived' | 'terminated'

Session lifecycle states.

Attributes: ACTIVE: Session is actively processing messages IDLE: Session exists but no recent activity ARCHIVED: Session archived (read-only) TERMINATED: Session permanently closed

filtersobject nullable

Additional filters

sortobject nullable

Sort configuration

Response

Successful Response

totalinteger required

Total matching sessions

paginationobject required

Pagination information

Example response

{
  "results": [
    {
      "agent_config": {
        "available_tools": [
          "list_retrievers",
          "get_retriever",
          "execute_retriever",
          "list_collections",
          "get_collection"
        ],
        "max_tokens": 4096,
        "model": "claude-sonnet-4-5-20250929",
        "system_prompt": "You are a video analysis assistant that helps users find and analyze video content.",
        "temperature": 0.7
      }
    }
  ]
}

Changes

Changed in 2 of the 34 revisions of this API.3

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 72cc17ba6f7f2See the full diff
    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter next_cursor

      new-optional-request-parameter