Amazon Q Q Quickresponses API
The Q Quickresponses API from Amazon Q — 2 operation(s) for q quickresponses.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-q:amazon-q-quickresponses-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: QBusiness Quickresponses API
version: '2023-11-27'
description: Generated from AWS's published Smithy model for QBusiness. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://wisdom.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Quickresponses
paths:
/knowledgeBases/{knowledgeBaseId}/quickResponses:
post:
operationId: CreateQuickResponse
summary: Create Quick Response
description: Creates an Amazon Q in Connect quick response.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateQuickResponseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomServiceQuotaExceededException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateQuickResponseRequest'
tags:
- Quickresponses
get:
operationId: ListQuickResponses
summary: List Quick Responses
description: Lists information about quick response.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListQuickResponsesResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListQuickResponsesRequest'
tags:
- Quickresponses
/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}:
get:
operationId: GetQuickResponse
summary: Get Quick Response
description: Retrieves the quick response.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetQuickResponseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetQuickResponseRequest'
tags:
- Quickresponses
post:
operationId: UpdateQuickResponse
summary: Update Quick Response
description: Updates an existing Amazon Q in Connect quick response.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateQuickResponseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomConflictException'
'412':
description: PreconditionFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/PreconditionFailedException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateQuickResponseRequest'
tags:
- Quickresponses
delete:
operationId: DeleteQuickResponse
summary: Delete Quick Response
description: Deletes a quick response.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteQuickResponseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteQuickResponseRequest'
tags:
- Quickresponses
components:
schemas:
UpdateQuickResponseRequest:
type: object
properties:
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
quickResponseId:
type: string
description: The identifier of the quick response.
name:
type: string
description: The name of the quick response.
content:
$ref: '#/components/schemas/QuickResponseDataProvider'
contentType:
type: string
description: The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
groupingConfiguration:
$ref: '#/components/schemas/GroupingConfiguration'
removeGroupingConfiguration:
type: boolean
description: Whether to remove the grouping configuration of the quick response.
description:
type: string
description: The updated description of the quick response.
removeDescription:
type: boolean
description: Whether to remove the description from the quick response.
shortcutKey:
type: string
description: The shortcut key of the quick response. The value should be unique across the knowledge base.
removeShortcutKey:
type: boolean
description: Whether to remove the shortcut key of the quick response.
isActive:
type: boolean
description: Whether the quick response is active.
channels:
type: array
items:
type: string
description: The Connect Customer contact channels this quick response applies to. The supported contact channel types include Chat.
language:
type: string
description: The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
required:
- knowledgeBaseId
- quickResponseId
WisdomAccessDeniedException:
type: object
properties:
message:
type: string
WisdomResourceNotFoundException:
type: object
properties:
message:
type: string
resourceName:
type: string
description: The specified resource name.
WisdomValidationException:
type: object
properties:
message:
type: string
WisdomServiceQuotaExceededException:
type: object
properties:
message:
type: string
QuickResponseContentProvider:
type: object
properties:
content:
type: string
description: The content of the quick response.
description: Exactly one member is set.
UnauthorizedException:
type: object
properties:
message:
type: string
GetQuickResponseResponse:
type: object
properties:
quickResponse:
$ref: '#/components/schemas/QuickResponseData'
ListQuickResponsesRequest:
type: object
properties:
nextToken:
type: string
description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
maxResults:
type: integer
description: The maximum number of results to return per page.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
required:
- knowledgeBaseId
CreateQuickResponseRequest:
type: object
properties:
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
name:
type: string
description: The name of the quick response.
content:
$ref: '#/components/schemas/QuickResponseDataProvider'
contentType:
type: string
description: The media type of the quick response content. Use application/x.quickresponse;format=plain for a quick response written in plain text. Use application/x.quickresponse;format=markdown for a quick response written in richtext.
groupingConfiguration:
$ref: '#/components/schemas/GroupingConfiguration'
description:
type: string
description: The description of the quick response.
shortcutKey:
type: string
description: The shortcut key of the quick response. The value should be unique across the knowledge base.
isActive:
type: boolean
description: Whether the quick response is active.
channels:
type: array
items:
type: string
description: The Connect Customer channels this quick response applies to.
language:
type: string
description: The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
clientToken:
type: string
description: 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 Making retries safe with idempotent APIs.
tags:
type: object
additionalProperties:
type: string
description: The tags used to organize, track, or control access for this resource.
required:
- knowledgeBaseId
- name
- content
QuickResponseSummary:
type: object
properties:
quickResponseArn:
type: string
description: The Amazon Resource Name (ARN) of the quick response.
quickResponseId:
type: string
description: The identifier of the quick response.
knowledgeBaseArn:
type: string
description: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base.
name:
type: string
description: The name of the quick response.
contentType:
type: string
description: The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
status:
type: string
description: The resource status of the quick response.
createdTime:
type: string
description: The timestamp when the quick response was created.
lastModifiedTime:
type: string
description: The timestamp when the quick response summary was last modified.
description:
type: string
description: The description of the quick response.
lastModifiedBy:
type: string
description: The Amazon Resource Name (ARN) of the user who last updated the quick response data.
isActive:
type: boolean
description: Whether the quick response is active.
channels:
type: array
items:
type: string
description: The Connect Customer contact channels this quick response applies to. The supported contact channel types include Chat.
tags:
type: object
additionalProperties:
type: string
description: The tags used to organize, track, or control access for this resource.
required:
- quickResponseArn
- quickResponseId
- knowledgeBaseArn
- knowledgeBaseId
- name
- contentType
- status
- createdTime
- lastModifiedTime
QuickResponseData:
type: object
properties:
quickResponseArn:
type: string
description: The Amazon Resource Name (ARN) of the quick response.
quickResponseId:
type: string
description: The identifier of the quick response.
knowledgeBaseArn:
type: string
description: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
name:
type: string
description: The name of the quick response.
contentType:
type: string
description: The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
status:
type: string
description: The status of the quick response data.
createdTime:
type: string
description: The timestamp when the quick response was created.
lastModifiedTime:
type: string
description: The timestamp when the quick response data was last modified.
contents:
$ref: '#/components/schemas/QuickResponseContents'
description:
type: string
description: The description of the quick response.
groupingConfiguration:
$ref: '#/components/schemas/GroupingConfiguration'
shortcutKey:
type: string
description: The shortcut key of the quick response. The value should be unique across the knowledge base.
lastModifiedBy:
type: string
description: The Amazon Resource Name (ARN) of the user who last updated the quick response data.
isActive:
type: boolean
description: Whether the quick response is active.
channels:
type: array
items:
type: string
description: The Connect Customer contact channels this quick response applies to. The supported contact channel types include Chat.
language:
type: string
description: The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
tags:
type: object
additionalProperties:
type: string
description: The tags used to organize, track, or control access for this resource.
required:
- quickResponseArn
- quickResponseId
- knowledgeBaseArn
- knowledgeBaseId
- name
- contentType
- status
- createdTime
- lastModifiedTime
QuickResponseDataProvider:
type: object
properties:
content:
type: string
description: The content of the quick response.
description: Exactly one member is set.
WisdomConflictException:
type: object
properties:
message:
type: string
CreateQuickResponseResponse:
type: object
properties:
quickResponse:
$ref: '#/components/schemas/QuickResponseData'
UpdateQuickResponseResponse:
type: object
properties:
quickResponse:
$ref: '#/components/schemas/QuickResponseData'
GetQuickResponseRequest:
type: object
properties:
quickResponseId:
type: string
description: The identifier of the quick response.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
required:
- quickResponseId
- knowledgeBaseId
ListQuickResponsesResponse:
type: object
properties:
quickResponseSummaries:
type: array
items:
$ref: '#/components/schemas/QuickResponseSummary'
description: Summary information about the quick responses.
nextToken:
type: string
description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
required:
- quickResponseSummaries
PreconditionFailedException:
type: object
properties:
message:
type: string
GroupingConfiguration:
type: object
properties:
criteria:
type: string
description: 'The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.'
values:
type: array
items:
type: string
description: The list of values that define different groups of Amazon Q in Connect users. When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Connect Customer routing profiles as values of this parameter.
QuickResponseContents:
type: object
properties:
plainText:
$ref: '#/components/schemas/QuickResponseContentProvider'
markdown:
$ref: '#/components/schemas/QuickResponseContentProvider'
DeleteQuickResponseRequest:
type: object
properties:
knowledgeBaseId:
type: string
description: The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
quickResponseId:
type: string
description: The identifier of the quick response to delete.
required:
- knowledgeBaseId
- quickResponseId
DeleteQuickResponseResponse:
type: object
properties: {}
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: wisdom
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qconnect/service/2020-10-19/qconnect-2020-10-19.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)