---
title: "POST /knowledgeBases/{knowledgeBaseId}/search/quickResponses"
method: POST
path: "/knowledgeBases/{knowledgeBaseId}/search/quickResponses"
---

# POST /knowledgeBases/{knowledgeBaseId}/search/quickResponses

`POST /knowledgeBases/{knowledgeBaseId}/search/quickResponses`

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

## Path parameters

- `knowledgeBaseId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer

## Request body

- object
  - `searchExpression` object, required — Information about the import job.
    - `queries` QuickResponseQueryField[] — The quick response query expressions.
      - `name` string, required — The name of the attribute to query the quick responses by.
      - `values` QuickResponseQueryValue[], required — The values of the attribute to query the quick responses by.
      - `operator` 'CONTAINS' | 'CONTAINS_AND_PREFIX', required — The operator to use for matching attribute field values in the query.
      - `allowFuzziness` boolean — Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
      - `priority` 'HIGH' | 'MEDIUM' | 'LOW' — The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
    - `filters` QuickResponseFilterField[] — The configuration of filtering rules applied to quick response query results.
      - `name` string, required — The name of the attribute field to filter the quick responses by.
      - `values` QuickResponseFilterValue[] — The values of attribute field to filter the quick response by.
      - `operator` 'EQUALS' | 'PREFIX', required — The operator to use for filtering.
      - `includeNoExistence` boolean — Whether to treat null value as a match for the attribute field.
    - `orderOnField` object — The quick response attribute fields on which the query results are ordered.
      - `name` string, required — The name of the attribute to order the quick response query results by.
      - `order` 'ASC' | 'DESC' — The order at which the quick responses are sorted by.
  - `attributes` object — The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.

## Response `200`

Success

- SearchQuickResponsesResponse
  - `results` QuickResponseSearchResultData[], required — The results of the quick response search.
    - `quickResponseArn` string, required — The Amazon Resource Name (ARN) of the quick response.
    - `quickResponseId` string, required — The identifier of the quick response.
    - `knowledgeBaseArn` string, required — The Amazon Resource Name (ARN) of the knowledge base.
    - `knowledgeBaseId` string, required — The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
    - `name` string, required — The name of the quick response.
    - `contentType` string, required — <p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p> </li> </ul>
    - `status` 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'CREATED' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED' | 'DELETED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_FAILED', required — The resource status of the quick response.
    - `contents` object, required — The contents of the quick response.
      - `plainText` QuickResponseContentProvider — The container quick response content.
        - `content` string, password — The content of the quick response.
      - `markdown` QuickResponseContentProvider — The container quick response content.
        - `content` string, password — The content of the quick response.
    - `createdTime` string, date-time, required — The timestamp when the quick response was created.
    - `lastModifiedTime` string, date-time, required — The timestamp when the quick response search result data was last modified.
    - `isActive` boolean, required — Whether the quick response is active.
    - `description` string — The description of the quick response.
    - `groupingConfiguration` object — The configuration information of the user groups that the quick response is accessible to.
      - `criteria` string, password — <p>The criteria used for grouping Amazon Q in Connect users.</p> <p>The following is the list of supported criteria values.</p> <ul> <li> <p> <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p> </li> </ul>
      - `values` GroupingValue[] — <p>The list of values that define different groups of Amazon Q in Connect users.</p> <ul> <li> <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p> </li> </ul>
    - `shortcutKey` string — The shortcut key of the quick response. The value should be unique across the knowledge base.
    - `lastModifiedBy` string — The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
    - `channels` Channel[] — The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.
    - `language` string — The language code value for the language in which the quick response is written.
    - `attributesNotInterpolated` ContactAttributeKey[] — The user defined contact attributes that are not resolved when the search result is returned.
    - `attributesInterpolated` ContactAttributeKey[] — The user defined contact attributes that are resolved when the search result is returned.
    - `tags` object — The tags used to organize, track, or control access for this resource.
  - `nextToken` string — The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Other responses

- `480` — RequestTimeoutException
- `481` — ValidationException
- `482` — UnauthorizedException
- `483` — AccessDeniedException
- `484` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/qconnect.md) · [All operations](https://skmtc.net/aws/apis/qconnect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qconnect/versions/833f5de92023/schema)