Chat

List webchat sessions

Changed on

API-key requests return a paginated object and require username. Dashboard requests with page or page_size return the same paginated object (sessions, page, page_size, total), scoped to the authenticated user. Dashboard requests without pagination parameters retain the legacy array response, limited to 100 sessions. Paginated requests default to page 1 and page_size 20, with page_size clamped to 1–100.

Required scope: chat

get/api/v1/chat/sessions

Request

  • Base URL
    http://localhost:6185
  • URL
    http://localhost:6185/api/v1/chat/sessions
  • Auth
    API key in header X-API-Key

Query parameters

pageinteger
page_sizeinteger
usernamestring

Response

Standard AstrBot success response

status'ok' required
messagestring
dataunknown required

Changes

  • 6b73b947caabRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      deleted the query request parameter platform_id

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id listChatSessions was added

    • info

      the endpoint scheme security ApiKeyHeader was removed from the API

    • info

      api tag Chat added

    • info

      api tag Open API removed

    • info

      the query request parameter username became optional

    • info

      for the query request parameter page_size, the max was increased from 100.00 to 200.00

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property const value ok was added for the status

  • 3d43cee2622aRevision changes
    • breaking

      the query request parameter username became required

    • breaking

      for the query request parameter page_size, the max was decreased from 200.00 to 100.00

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property const value ok was removed for the status

    • breaking

      the response's property type changed from no type to object for status

    • info

      api operation id listChatSessions removed and replaced with

    • info

      the endpoint scheme security ApiKeyHeader was added to the API

    • info

      api tag Open API added

    • info

      api tag Chat removed

    • info

      added the new optional query request parameter platform_id

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status