Sign in
chat-sessions

List the current Workspace chat inbox.

Changed on

Returns root sessions in descending update order. Participant filters use ALL semantics and are evaluated by the database before pagination.

get/api/chat-session

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/chat-session
  • Auth: HTTP bearer

Query parameters

project_idstring
limitinteger

Maximum number of sessions to return.

page_tokenstring

Opaque pagination token from a previous response.

agent_namestring

Optional Agent name.

participant_user_idstring[]

Human participants required in every returned session.

include_workflow_runsboolean

Include sessions created by WorkflowRuns.

searchstring

Case-insensitive literal substring matched against session titles.

group_by'none' | 'agent' | 'status' | 'date' | 'project'

Server-side grouping applied after all inbox filters.

group_keystring

Opaque group key returned by an earlier grouped response.

time_zonestring

IANA time zone used to calculate date groups.

active_agent_namestring

Agent name from the active session route.

active_session_idstring

Session ID from the active session route.

include_filter_optionsboolean

Include the participant options used by the sidebar filter.

Response

Paginated chat sessions and available participant filters.

has_next_pageboolean required
next_page_tokenstring required

Changes

  • d197d7b57b8dRevision changes
    • warning

      added the new project enum value to the // response property for the response status

    • info

      added the new optional query request parameter project_id

    • info

      added the new enum value project to the query request parameter group_by

    • 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

  • 22d6332b6f97Revision changes
    • info

      added the new optional query request parameter active_agent_name

    • info

      added the new optional query request parameter active_session_id

    • info

      added the new optional query request parameter group_by

    • info

      added the new optional query request parameter group_key

    • info

      added the new optional query request parameter include_filter_options

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter time_zone

    • info

      added the required property to the response with the status