Amazon Q Connect
Amazon Q actions Amazon Q data types Powered by Amazon Bedrock : Amazon Web Services implements automated abuse detection . Because Amazon Q in Connect is…
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 Q actions Amazon Q data types Powered by Amazon Bedrock : Amazon Web Services implements automated abuse detection . Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI). Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Connect Customer Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately. Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests. Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files. For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Connect Customer Administrator Guide .
Endpoints 96
Message template
- POSTActivate message template
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/activateActivates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated… - GETList message templates
/knowledgeBases/:knowledgeBaseId/messageTemplates?nextToken=string&maxResults=0Lists all the available Amazon Q in Connect message templates for the specified knowledge base. - POSTCreate message template
/knowledgeBases/:knowledgeBaseId/messageTemplatesCreates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message… - POSTCreate message template attachment
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/attachmentsUploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each… - GETList message template versions
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/versions?nextToken=string&maxResults=0Lists all the available versions for the specified Amazon Q in Connect message template. - POSTCreate message template version
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/versionsCreates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and… - POSTDeactivate message template
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/deactivateDeactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION… - GETGet message template
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateIdRetrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example,… - POSTUpdate message template
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateIdUpdates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template… - DELETEDelete message template
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateIdDeletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide… - DELETEDelete message template attachment
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/attachments/:attachmentIdDeletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template… - POSTRender message template
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/renderRenders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the… - POSTUpdate message template metadata
/knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/metadataUpdates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration…
AI agent
- GETList aI agents
/assistants/:assistantId/aiagents?nextToken=string&maxResults=0&origin=stringLists AI Agents. - POSTCreate aI agent
/assistants/:assistantId/aiagentsCreates an Amazon Q in Connect AI Agent. - GETList aI agent versions
/assistants/:assistantId/aiagents/:aiAgentId/versions?nextToken=string&maxResults=0&origin=stringList AI Agent versions. - POSTCreate aI agent version
/assistants/:assistantId/aiagents/:aiAgentId/versionsCreates and Amazon Q in Connect AI Agent version. - GETGet aI agent
/assistants/:assistantId/aiagents/:aiAgentIdGets an Amazon Q in Connect AI Agent. - POSTUpdate aI agent
/assistants/:assistantId/aiagents/:aiAgentIdUpdates an AI Agent. - DELETEDelete aI agent
/assistants/:assistantId/aiagents/:aiAgentIdDeletes an Amazon Q in Connect AI Agent. - DELETEDelete aI agent version
/assistants/:assistantId/aiagents/:aiAgentId/versions/:versionNumberDeletes an Amazon Q in Connect AI Agent Version.
AI guardrail
- GETList aI guardrails
/assistants/:assistantId/aiguardrails?nextToken=string&maxResults=0Lists the AI Guardrails available on the Amazon Q in Connect assistant. - POSTCreate aI guardrail
/assistants/:assistantId/aiguardrailsCreates an Amazon Q in Connect AI Guardrail. - GETList aI guardrail versions
/assistants/:assistantId/aiguardrails/:aiGuardrailId/versions?nextToken=string&maxResults=0Lists AI Guardrail versions. - POSTCreate aI guardrail version
/assistants/:assistantId/aiguardrails/:aiGuardrailId/versionsCreates an Amazon Q in Connect AI Guardrail version. - GETGet aI guardrail
/assistants/:assistantId/aiguardrails/:aiGuardrailIdGets the Amazon Q in Connect AI Guardrail. - POSTUpdate aI guardrail
/assistants/:assistantId/aiguardrails/:aiGuardrailIdUpdates an AI Guardrail. - DELETEDelete aI guardrail
/assistants/:assistantId/aiguardrails/:aiGuardrailIdDeletes an Amazon Q in Connect AI Guardrail. - DELETEDelete aI guardrail version
/assistants/:assistantId/aiguardrails/:aiGuardrailId/versions/:versionNumberDelete and Amazon Q in Connect AI Guardrail version.
AI prompt
- GETList aI prompts
/assistants/:assistantId/aiprompts?nextToken=string&maxResults=0&origin=stringLists the AI Prompts available on the Amazon Q in Connect assistant. - POSTCreate aI prompt
/assistants/:assistantId/aipromptsCreates an Amazon Q in Connect AI Prompt. - GETList aI prompt versions
/assistants/:assistantId/aiprompts/:aiPromptId/versions?nextToken=string&maxResults=0&origin=stringLists AI Prompt versions. - POSTCreate aI prompt version
/assistants/:assistantId/aiprompts/:aiPromptId/versionsCreates an Amazon Q in Connect AI Prompt version. - GETGet aI prompt
/assistants/:assistantId/aiprompts/:aiPromptIdGets and Amazon Q in Connect AI Prompt. - POSTUpdate aI prompt
/assistants/:assistantId/aiprompts/:aiPromptIdUpdates an AI Prompt. - DELETEDelete aI prompt
/assistants/:assistantId/aiprompts/:aiPromptIdDeletes an Amazon Q in Connect AI Prompt. - DELETEDelete aI prompt version
/assistants/:assistantId/aiprompts/:aiPromptId/versions/:versionNumberDelete and Amazon Q in Connect AI Prompt version.
Assistant
- GETList assistants
/assistants?nextToken=string&maxResults=0Lists information about assistants. - POSTCreate assistant
/assistantsCreates an Amazon Q in Connect 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=0&nextChunkToken=string&recommendationType=stringDeprecated. This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant… - GETList models
/assistants/:assistantId/models?aiPromptType=string&modelLifecycle=string&nextToken=string&maxResults=0Lists the models available to an Amazon Q in Connect assistant in the assistant's Amazon Web Services Region. The available models are determined by the… - 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… - PUTPut feedback
/assistants/:assistantId/feedbackProvides feedback against the specified assistant for the specified target. This API only supports generative targets. - POSTQuery assistant
/assistants/:assistantId/queryDeprecated. This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant… - PUTRegister assistant replica key
/assistants/:assistantId/replicaKeyRegisters a replica Region KMS key for an Amazon Q in Connect assistant. To use this operation, you must have kms:GenerateDataKey permission on the replica key. - POSTUpdate assistant aI agent
/assistants/:assistantId/aiagentConfigurationUpdates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant. - DELETERemove assistant aI agent
/assistants/:assistantId/aiagentConfiguration?aiAgentType=string&orchestratorUseCase=stringRemoves the AI Agent that is set for use by default on an Amazon Q in Connect Assistant. - POSTRetrieve
/assistants/:assistantId/retrieveRetrieves content from knowledge sources based on a query. - 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 Q in Connect 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 Amazon Q in Connect 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.
Content association
- GETList content associations
/knowledgeBases/:knowledgeBaseId/contents/:contentId/associations?nextToken=string&maxResults=0Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with… - POSTCreate content association
/knowledgeBases/:knowledgeBaseId/contents/:contentId/associationsCreates an association between a content resource in a knowledge base and step-by-step guides . Step-by-step guides offer instructions to agents for resolving… - GETGet content association
/knowledgeBases/:knowledgeBaseId/contents/:contentId/associations/:contentAssociationIdReturns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with… - DELETEDelete content association
/knowledgeBases/:knowledgeBaseId/contents/:contentId/associations/:contentAssociationIdDeletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with…
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 Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an… - PUTRegister knowledge base replica key
/knowledgeBases/:knowledgeBaseId/replicaKeyRegisters a replica Region KMS key for an Amazon Q in Connect knowledge base. To use this operation, you must have kms:GenerateDataKey permission on the… - 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 message templates
/knowledgeBases/:knowledgeBaseId/search/messageTemplates?nextToken=string&maxResults=0Searches for Amazon Q in Connect message templates in the specified knowledge base. - POSTSearch quick responses
/knowledgeBases/:knowledgeBaseId/search/quickResponses?nextToken=string&maxResults=0Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect 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 an Amazon Q in Connect quick response. - GETGet quick response
/knowledgeBases/:knowledgeBaseId/quickResponses/:quickResponseIdRetrieves the quick response. - POSTUpdate quick response
/knowledgeBases/:knowledgeBaseId/quickResponses/:quickResponseIdUpdates an existing Amazon Q in Connect 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. Connect Customer creates a new Amazon Q in Connect session for… - GETGet next message
/assistants/:assistantId/sessions/:sessionId/messages/next?nextMessageToken=stringRetrieves next message on an Amazon Q in Connect session. - GETGet session
/assistants/:assistantId/sessions/:sessionIdRetrieves information for a specified session. - POSTUpdate session
/assistants/:assistantId/sessions/:sessionIdUpdates a session. A session is a contextual container used for generating recommendations. Connect Customer updates the existing Amazon Q in Connect session… - GETList messages
/assistants/:assistantId/sessions/:sessionId/messages?nextToken=string&maxResults=0&filter=stringLists messages on an Amazon Q in Connect session. - GETList spans
/assistants/:assistantId/sessions/:sessionId/spans?nextToken=string&maxResults=0Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations. - POSTSend message
/assistants/:assistantId/sessions/:sessionId/messageSubmits a message to the Amazon Q in Connect session. - PATCHUpdate session data
/assistants/:assistantId/sessions/:sessionId/dataUpdates the data stored on an Amazon Q in Connect 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
- 96 operations on 59 pathsPOST 40GET 34DELETE 18PUT 3PATCH 1
2 marked deprecated - Main resources
- Knowledge base 15Assistant 14Message template 13AI agent 8AI guardrail 8AI prompt 8Session 8Content 6Quick response 5Assistant association 4
- 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 Q Connect 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 Q Connect 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 “Activate message template” (POST /knowledgeBases/:knowledgeBaseId/messageTemplates/:messageTemplateId/activate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Q Connect?
Amazon Q actions Amazon Q data types Powered by Amazon Bedrock : Amazon Web Services implements automated abuse detection . Because Amazon Q in Connect is… It is listed under Communication and has 96 endpoints.
Who publishes the Amazon Q Connect?
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 Q Connect?
Requests go to https://wisdom.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Q Connect?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Q Connect have?
96 operations on 59 paths (40 POST, 34 GET, 18 DELETE, 3 PUT, 1 PATCH). The largest groups are Knowledge base, Assistant, Message template, AI agent.
Is forking the Amazon Q Connect free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.