--- title: "GET /applications/{applicationId}/conversations/{conversationId}" method: GET path: "/applications/{applicationId}/conversations/{conversationId}" --- # GET /applications/{applicationId}/conversations/{conversationId} `GET /applications/{applicationId}/conversations/{conversationId}` Gets a list of messages associated with an Amazon Q Business web experience. ## Path parameters - `conversationId` string, required - `applicationId` string, required ## Query parameters - `userId` string - `nextToken` string - `maxResults` integer ## Response `200` Success - ListMessagesResponse - `messages` Message[] — An array of information on one or more messages. - `messageId` string — The identifier of the Amazon Q Business web experience message. - `body` string — The content of the Amazon Q Business web experience message. - `time` string, date-time — The timestamp of the first Amazon Q Business web experience message. - `type` 'USER' | 'SYSTEM' — The type of Amazon Q Business message, whether HUMAN or AI generated. - `attachments` AttachmentOutput[] — A file directly uploaded into an Amazon Q Business web experience chat. - `name` string — The name of a file uploaded during chat. - `status` 'FAILED' | 'SUCCESS' — The status of a file uploaded during chat. - `error` object — An error associated with a file uploaded during chat. - `errorMessage` string — The message explaining the Amazon Q Business request error. - `errorCode` 'InternalError' | 'InvalidRequest' | 'ResourceInactive' | 'ResourceNotFound' — The code associated with the Amazon Q Business request error. - `attachmentId` string — The unique identifier of the Amazon Q Business attachment. - `conversationId` string — The unique identifier of the Amazon Q Business conversation. - `sourceAttribution` SourceAttribution[] — The source documents used to generate Amazon Q Business web experience message. - `title` string — The title of the document which is the source for the Amazon Q Business generated response. - `snippet` string — The content extract from the document on which the generated response is based. - `url` string — The URL of the document which is the source for the Amazon Q Business generated response. - `citationNumber` integer — The number attached to a citation in an Amazon Q Business generated response. - `updatedAt` string, date-time — The Unix timestamp when the Amazon Q Business application was last updated. - `textMessageSegments` TextSegment[] — A text extract from a source document that is used for source attribution. - `beginOffset` integer — The zero-based location in the response string where the source attribution starts. - `endOffset` integer — The zero-based location in the response string where the source attribution ends. - `snippetExcerpt` object — The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response. - `text` string — The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response. - `mediaId` string — The identifier of the media object associated with the text segment in the source attribution.Deprecated in favor of using mediaId within the respective sourceDetails field. - `mediaMimeType` string — The MIME type (image/png) of the media object associated with the text segment in the source attribution.Deprecated in favor of using mediaMimeType within the respective sourceDetails field. - `sourceDetails` object — Source information for a segment of extracted text, including its media type. - `imageSourceDetails` object — Details specific to image content within the source. - `mediaId` string — Unique identifier for the image file. - `mediaMimeType` string — The MIME type of the image file. - `audioSourceDetails` object — Details specific to audio content within the source. - `mediaId` string — Unique identifier for the audio media file. - `mediaMimeType` string — The MIME type of the audio file (e.g., audio/mp3, audio/wav). - `startTimeMilliseconds` integer — The starting timestamp in milliseconds for the relevant audio segment. - `endTimeMilliseconds` integer — The ending timestamp in milliseconds for the relevant audio segment. - `audioExtractionType` 'TRANSCRIPT' | 'SUMMARY' — The type of audio extraction performed on the content. - `videoSourceDetails` object — Details specific to video content within the source. - `mediaId` string — Unique identifier for the video media file. - `mediaMimeType` string — The MIME type of the video file (e.g., video/mp4, video/avi). - `startTimeMilliseconds` integer — The starting timestamp in milliseconds for the relevant video segment. - `endTimeMilliseconds` integer — The ending timestamp in milliseconds for the relevant video segment. - `videoExtractionType` 'TRANSCRIPT' | 'SUMMARY' — The type of video extraction performed on the content. - `documentId` string — The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the GetDocumentContent API to retrieve the actual document content for user verification. - `indexId` string — The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored. - `datasourceId` string — The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid". - `actionReview` ActionReview — An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business. - `pluginId` string — The identifier of the plugin associated with the action review. - `pluginType` 'SERVICE_NOW' | 'SALESFORCE' | 'JIRA' | 'ZENDESK' | 'CUSTOM' | 'QUICKSIGHT' | 'SERVICENOW_NOW_PLATFORM' | 'JIRA_CLOUD' | 'SALESFORCE_CRM' | 'ZENDESK_SUITE' | 'ATLASSIAN_CONFLUENCE' | 'GOOGLE_CALENDAR' | 'MICROSOFT_TEAMS' | 'MICROSOFT_EXCHANGE' | 'PAGERDUTY_ADVANCE' | 'SMARTSHEET' | 'ASANA' — The type of plugin. - `payload` object — Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. - `payloadFieldNameSeparator` string — A string used to retain information about the hierarchical contexts within an action review payload. - `actionExecution` ActionExecution — Performs an Amazon Q Business plugin action during a non-streaming chat conversation. - `pluginId` string, required — The identifier of the plugin the action is attached to. - `payload` object, required — A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action. - `payloadFieldNameSeparator` string, required — A string used to retain information about the hierarchical contexts within an action execution event payload. - `nextToken` string — If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages. ## Other responses - `480` — InternalServerException - `481` — ResourceNotFoundException - `482` — LicenseNotFoundException - `483` — ThrottlingException - `484` — ValidationException - `485` — AccessDeniedException --- [API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/versions/82966d6c4053/schema)