Sign in

v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB
Conversations

Get conversation by ID

Retrieve a specific conversation with its full message history.

Overview:

Returns the complete conversation including all messages, citations, feedback, and metadata. Messages can be paginated for long conversations.

Message Pagination:

For conversations with many messages, use pagination parameters:

  • page: Page number (default: 1)
  • limit: Messages per page (default: 10)
  • sortBy: Sort field (default: createdAt)
  • sortOrder: 'asc' or 'desc' (default: desc)

Access Control:

Users can access conversations they own or that have been shared with them.

get/conversations/{conversationId}

Path parameters

conversationIdstring objectId required

Unique conversation identifier

Query parameters

pageinteger

Page number for message pagination

limitinteger

Number of messages per page

sortBy'createdAt' | 'messageType' | 'content'

Field to sort messages by

sortOrder'asc' | 'desc'

Sort direction

searchstring

Case-insensitive search across conversation title and message content

startDatestring date-time

Filter messages created on or after this date (ISO 8601)

endDatestring date-time

Filter messages created on or before this date (ISO 8601)

sharedboolean

Filter by shared status of the conversation

messageType'user_query' | 'bot_response' | 'error' | 'feedback' | 'system'

Filter messages by type

Response

Conversation with paginated messages, applied filter metadata, and request metadata