Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

  1. Call DeleteKnowledgeBase.

  2. Call DeleteDataIntegration.

  3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

  4. Call CreateKnowledgeBase.

post/knowledgeBases

Request body

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>.

namestring required

The name of the knowledge base.

knowledgeBaseType'EXTERNAL' | 'CUSTOM' | 'QUICK_RESPONSES' | 'MESSAGE_TEMPLATES' | 'MANAGED' required

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

descriptionstring

The description.

tagsobject

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

Response

Success