Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Creates Amazon Q in Connect content. Before to calling this API, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to upload an asset.

post/knowledgeBases/{knowledgeBaseId}/contents

Path parameters

knowledgeBaseIdstring required

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Request body

namestring required

The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a> API.

titlestring

The title of the content. If not set, the title is equal to the name.

overrideLinkOutUristring

The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

metadataobject

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

uploadIdstring required

A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.

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