Conversations

List conversation history data

Changed on

Required scope: data

get/api/v1/conversations

Request

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

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
dataunknown required

Changes

  • 9f8da1b16ca0Revision changes
    • info

      added the new optional query request parameter group_by_session

    • info

      added the new optional query request parameter keyword

    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order

    • info

      added the new optional query request parameter umo

  • 4463c5ffdb9cRevision changes
    • info

      endpoint added