PIpipeshub-ai
Conversations

Get conversation by ID

Changed on

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: 20)
  • 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.

Query parameters not listed here are ignored, not refused.

get/conversations/{conversationId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/conversations/{conversationId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: conversation:read

Path parameters

conversationIdstring objectId required

Unique conversation identifier

Query parameters

pageinteger

Page number for message pagination. Read with parseInt, so a fraction such as 1.5 is tolerated and truncated (page 1).

limitinteger

Number of messages per page. Read with parseInt, so a fraction such as 5.5 is tolerated and truncated (5).

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

Field to sort messages by

sortOrder'asc' | 'desc'

Sort direction

searchstring

Case-insensitive match against the conversation's title and its messages' content. Applies to the conversation, not its messages: when nothing matches the answer is 404; when something matches every message is returned.

startDatestring

Applies to the conversation, not its messages: when the conversation was created before this instant the answer is 404. Any value JavaScript's Date parses is accepted (an ISO 8601 date or date-time is the documented form); a value it cannot parse is refused with 400.

endDatestring

Applies to the conversation, not its messages: when the conversation was created after this instant the answer is 404. Parsed like startDate.

shared'true' | 'false' | '1' | '0'

Filters on the conversation's isShared; a conversation that does not match is answered 404. Read case-insensitively; any other value is refused with 400.

projectIdstring

unassigned matches only a conversation linked to no project; a 24-character ObjectId matches only a conversation linked to that project. A conversation that does not match is answered 404. Any other value is ignored.

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

Checked against the listed values (400 otherwise) but not applied: every message type is returned.

Response

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

Changes

  • dbb5e203b445Revision changes
    • breaking

      the query request parameter shared was restricted to a list of enum values

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2} to the query request parameter endDate

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2} to the query request parameter startDate

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      the ///// response's property type changed from object to no type for 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

      added the new optional query request parameter projectId

    • info

      added the new enum value 0 to the query request parameter shared

    • info

      added the new enum value 1 to the query request parameter shared

    • info

      added the new enum value false to the query request parameter shared

    • info

      added the new enum value tool_call to the query request parameter messageType

    • info

      added the new enum value true to the query request parameter shared

    • info

      for the query request parameter endDate, the format was generalized from date-time to no format

    • info

      for the query request parameter shared, the type was generalized from boolean to string

    • info

      for the query request parameter startDate, the format was generalized from date-time to no format

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added to the ///// response property anyOf list for the response status

    • info

      added to the ///// response property anyOf list for the response status

    • info

      added to the ///// response property anyOf list for the response status

    • info

      added to the ///// response property anyOf list for the response status

    • info

      added to the ///// response property anyOf list for the response status

  • a90ab79f26a1Revision changes
    • 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

    • 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

    • 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