Sign in
Conversations

List conversation history data

Required scope: data

get/api/v1/conversations

Query parameters

pageinteger
page_sizeinteger
platform_idstring
user_idstring
searchstring
platformsstring

Comma-separated platform IDs.

message_typesstring

Comma-separated message types.

exclude_idsstring

Comma-separated user IDs to exclude.

exclude_platformsstring

Comma-separated platforms to exclude.

keywordstring

Match conversation titles or message content.

umostring

Match the unified message origin.

sort_by'created_at' | 'updated_at'
sort_order'asc' | 'desc'
group_by_sessionboolean

Paginate by UMO and return all conversation summaries for each selected session.

include_historyboolean

Include full message history in each conversation.

Response

Standard AstrBot success response

status'ok' required
messagestring
{"stackTrail":"components:schemas:SuccessEnvelope:properties:data","oasType":"schema","type":"unknown"}

Changes

Changed in 4 of the 13 revisions of this API.17

  • 9f8da1b16ca05See the full diff
    • ○

      added the new optional query request parameter group_by_session

      new-optional-request-parameter

    • ○

      added the new optional query request parameter keyword

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort_by

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort_order

      new-optional-request-parameter

    • ○

      added the new optional query request parameter umo

      new-optional-request-parameter

  • 4463c5ffdb9c1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 9832b5ec01b51See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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

  • 6b73b947caab1See the full diff
    • ○

      endpoint added

      endpoint-added

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