Amazon Connect Wisdom Service
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're
actively speaking with customers. Agents can search across connected repositories from within
their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a
knowledge base, for example, or manage content by uploading custom files.
Endpoints 41
Assistant
- GETList assistants
/assistants?nextToken=string&maxResults=0Lists information about assistants. - POSTCreate assistant
/assistantsCreates an Amazon Connect Wisdom assistant. - GETGet assistant
/assistants/:assistantIdRetrieves information about an assistant. - DELETEDelete assistant
/assistants/:assistantIdDeletes an assistant. - GETGet recommendations
/assistants/:assistantId/sessions/:sessionId/recommendations?maxResults=0&waitTimeSeconds=0Deprecated. Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use… - POSTNotify recommendations received
/assistants/:assistantId/sessions/:sessionId/recommendations/notifyRemoves the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with… - POSTQuery assistant
/assistants/:assistantId/queryDeprecated. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations . - POSTSearch sessions
/assistants/:assistantId/searchSessions?nextToken=string&maxResults=0Searches for sessions.
Assistant association
- GETList assistant associations
/assistants/:assistantId/associations?nextToken=string&maxResults=0Lists information about assistant associations. - POSTCreate assistant association
/assistants/:assistantId/associationsCreates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An… - GETGet assistant association
/assistants/:assistantId/associations/:assistantAssociationIdRetrieves information about an assistant association. - DELETEDelete assistant association
/assistants/:assistantId/associations/:assistantAssociationIdDeletes an assistant association.
Content
- GETList contents
/knowledgeBases/:knowledgeBaseId/contents?nextToken=string&maxResults=0Lists the content. - POSTCreate content
/knowledgeBases/:knowledgeBaseId/contentsCreates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset. - GETGet content
/knowledgeBases/:knowledgeBaseId/contents/:contentIdRetrieves content, including a pre-signed URL to download the content. - POSTUpdate content
/knowledgeBases/:knowledgeBaseId/contents/:contentIdUpdates information about the content. - DELETEDelete content
/knowledgeBases/:knowledgeBaseId/contents/:contentIdDeletes the content. - GETGet content summary
/knowledgeBases/:knowledgeBaseId/contents/:contentId/summaryRetrieves summary information about the content.
Knowledge base
- GETList knowledge bases
/knowledgeBases?nextToken=string&maxResults=0Lists the knowledge bases. - POSTCreate knowledge base
/knowledgeBasesCreates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and… - GETGet import job
/knowledgeBases/:knowledgeBaseId/importJobs/:importJobIdRetrieves the started import job. - DELETEDelete import job
/knowledgeBases/:knowledgeBaseId/importJobs/:importJobIdDeletes the quick response import job. - GETGet knowledge base
/knowledgeBases/:knowledgeBaseIdRetrieves information about the knowledge base. - DELETEDelete knowledge base
/knowledgeBases/:knowledgeBaseIdDeletes the knowledge base. When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon… - GETList import jobs
/knowledgeBases/:knowledgeBaseId/importJobs?nextToken=string&maxResults=0Lists information about import jobs. - POSTStart import job
/knowledgeBases/:knowledgeBaseId/importJobsStart an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that… - POSTUpdate knowledge base template uri
/knowledgeBases/:knowledgeBaseId/templateUriUpdates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format;… - DELETERemove knowledge base template uri
/knowledgeBases/:knowledgeBaseId/templateUriRemoves a URI template from a knowledge base. - POSTSearch content
/knowledgeBases/:knowledgeBaseId/search?nextToken=string&maxResults=0Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name. - POSTSearch quick responses
/knowledgeBases/:knowledgeBaseId/search/quickResponses?nextToken=string&maxResults=0Searches existing Wisdom quick responses in a Wisdom knowledge base. - POSTStart content upload
/knowledgeBases/:knowledgeBaseId/uploadGet a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the…
Quick response
- GETList quick responses
/knowledgeBases/:knowledgeBaseId/quickResponses?nextToken=string&maxResults=0Lists information about quick response. - POSTCreate quick response
/knowledgeBases/:knowledgeBaseId/quickResponsesCreates a Wisdom quick response. - GETGet quick response
/knowledgeBases/:knowledgeBaseId/quickResponses/:quickResponseIdRetrieves the quick response. - POSTUpdate quick response
/knowledgeBases/:knowledgeBaseId/quickResponses/:quickResponseIdUpdates an existing Wisdom quick response. - DELETEDelete quick response
/knowledgeBases/:knowledgeBaseId/quickResponses/:quickResponseIdDeletes a quick response.
Session
- POSTCreate session
/assistants/:assistantId/sessionsCreates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on… - GETGet session
/assistants/:assistantId/sessions/:sessionIdRetrieves information for a specified session.
- GETList tags for resource
/tags/:resourceArnLists the tags for the specified resource. - POSTTag resource
/tags/:resourceArnAdds the specified tags to the specified resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource.
API details
- Base URL
https://wisdom.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 41 operations on 24 pathsPOST 17GET 16DELETE 8
2 marked deprecated - Main resources
- Knowledge base 13Assistant 8Content 6Quick response 5Assistant association 4Session 2
- Description format
- AWS Smithy model, API version
2020-10-19 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Connect Wisdom Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Connect Wisdom Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List assistants” (GET /assistants?nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Connect Wisdom Service?
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across… It is listed under Communication and has 41 endpoints.
Who publishes the Amazon Connect Wisdom Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Connect Wisdom Service?
Requests go to https://wisdom.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Connect Wisdom Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Connect Wisdom Service have?
41 operations on 24 paths (17 POST, 16 GET, 8 DELETE). The largest groups are Knowledge base, Assistant, Content, Quick response.
Is forking the Amazon Connect Wisdom Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.