Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Creates an Amazon Q in Connect quick response.

post/knowledgeBases/{knowledgeBaseId}/quickResponses

Path parameters

knowledgeBaseIdstring required

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Request body

namestring required

The name of the quick response.

contentTypestring
<p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p> </li> </ul>
descriptionstring

The description of the quick response.

shortcutKeystring

The shortcut key of the quick response. The value should be unique across the knowledge base.

isActiveboolean

Whether the quick response is active.

channelsChannel[]

The Amazon Connect channels this quick response applies to.

languagestring

The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code>

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

tagsobject

The tags used to organize, track, or control access for this resource.

Response

Success