Amazon Web Services, Inc.

QBusiness

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within…

Developer tools#openapi

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

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide . For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations . For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide . The following resources provide additional information about using the Amazon Q Business API: Setting up for Amazon Q Business Amazon Q Business CLI Reference Amazon Web Services General Reference

Endpoints 82

Application

  • GETList applications/applications?nextToken=string&maxResults=0Lists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your…
  • POSTCreate application/applicationsCreates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q…
  • GETGet application/applications/:applicationIdGets information about an existing Amazon Q Business application.
  • PUTUpdate application/applications/:applicationIdUpdates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions…
  • DELETEDelete application/applications/:applicationIdDeletes an Amazon Q Business application.

Data accessor

  • GETList data accessors/applications/:applicationId/dataaccessors?nextToken=string&maxResults=0Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name,…
  • POSTCreate data accessor/applications/:applicationId/dataaccessorsCreates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to…
  • GETGet data accessor/applications/:applicationId/dataaccessors/:dataAccessorIdRetrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier,…
  • PUTUpdate data accessor/applications/:applicationId/dataaccessors/:dataAccessorIdUpdates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name…
  • DELETEDelete data accessor/applications/:applicationId/dataaccessors/:dataAccessorIdDeletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted…

Data source

  • GETList data sources/applications/:applicationId/indices/:indexId/datasources?nextToken=string&maxResults=0Lists the Amazon Q Business data source connectors that you have created.
  • POSTCreate data source/applications/:applicationId/indices/:indexId/datasourcesCreates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data…
  • GETGet data source/applications/:applicationId/indices/:indexId/datasources/:dataSourceIdGets information about an existing Amazon Q Business data source connector.
  • PUTUpdate data source/applications/:applicationId/indices/:indexId/datasources/:dataSourceIdUpdates an existing Amazon Q Business data source connector.
  • DELETEDelete data source/applications/:applicationId/indices/:indexId/datasources/:dataSourceIdDeletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API…

Index

  • GETList indices/applications/:applicationId/indices?nextToken=string&maxResults=0Lists the Amazon Q Business indices you have created.
  • POSTCreate index/applications/:applicationId/indicesCreates an Amazon Q Business index. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex . The Status…
  • GETGet index/applications/:applicationId/indices/:indexIdGets information about an existing Amazon Q Business index.
  • PUTUpdate index/applications/:applicationId/indices/:indexIdUpdates an Amazon Q Business index.
  • DELETEDelete index/applications/:applicationId/indices/:indexIdDeletes an Amazon Q Business index.

Plugin

  • GETList plugins/applications/:applicationId/plugins?nextToken=string&maxResults=0Lists configured Amazon Q Business plugins.
  • POSTCreate plugin/applications/:applicationId/pluginsCreates an Amazon Q Business plugin.
  • GETGet plugin/applications/:applicationId/plugins/:pluginIdGets information about an existing Amazon Q Business plugin.
  • PUTUpdate plugin/applications/:applicationId/plugins/:pluginIdUpdates an Amazon Q Business plugin.
  • DELETEDelete plugin/applications/:applicationId/plugins/:pluginIdDeletes an Amazon Q Business plugin.

Retriever

  • GETList retrievers/applications/:applicationId/retrievers?nextToken=string&maxResults=0Lists the retriever used by an Amazon Q Business application.
  • POSTCreate retriever/applications/:applicationId/retrieversAdds a retriever to your Amazon Q Business application.
  • GETGet retriever/applications/:applicationId/retrievers/:retrieverIdGets information about an existing retriever used by an Amazon Q Business application.
  • PUTUpdate retriever/applications/:applicationId/retrievers/:retrieverIdUpdates the retriever used for your Amazon Q Business application.
  • DELETEDelete retriever/applications/:applicationId/retrievers/:retrieverIdDeletes the retriever used by an Amazon Q Business application.

Web experience

  • GETList web experiences/applications/:applicationId/experiences?nextToken=string&maxResults=0Lists one or more Amazon Q Business Web Experiences.
  • POSTCreate web experience/applications/:applicationId/experiencesCreates an Amazon Q Business web experience.
  • GETGet web experience/applications/:applicationId/experiences/:webExperienceIdGets information about an existing Amazon Q Business web experience.
  • PUTUpdate web experience/applications/:applicationId/experiences/:webExperienceIdUpdates an Amazon Q Business web experience.
  • DELETEDelete web experience/applications/:applicationId/experiences/:webExperienceIdDeletes an Amazon Q Business web experience.
  • GETGet policy/applications/:applicationId/policyRetrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions…
  • POSTAssociate permission/applications/:applicationId/policyAdds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy…
  • POSTBatch delete document/applications/:applicationId/indices/:indexId/documents/deleteAsynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index. You can see the progress of the deletion,…
  • POSTBatch put document/applications/:applicationId/indices/:indexId/documentsAdds one or more documents to an Amazon Q Business index. You use this API to: ingest your structured and unstructured documents and documents stored in an…
  • PUTUpdate subscription/applications/:applicationId/subscriptions/:subscriptionIdUpdates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier…
  • DELETECancel subscription/applications/:applicationId/subscriptions/:subscriptionIdUnsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature…
  • GETList conversations/applications/:applicationId/conversations?userId=string&nextToken=string&maxResults=0Lists one or more Amazon Q Business conversations.
  • POSTChat sync/applications/:applicationId/conversations?sync=&userId=string&userGroups=Starts or continues a non-streaming Amazon Q Business conversation.
  • GETCheck document access/applications/:applicationId/index/:indexId/users/:userId/documents/:documentId/check-document-access?dataSourceId=stringVerifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document…
  • POSTCreate anonymous web experience url/applications/:applicationId/experiences/:webExperienceId/anonymous-urlCreates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
  • GETList chat response configurations/applications/:applicationId/chatresponseconfigurations?maxResults=0&nextToken=stringRetrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about…
  • POSTCreate chat response configuration/applications/:applicationId/chatresponseconfigurationsCreates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system…
  • GETList subscriptions/applications/:applicationId/subscriptions?nextToken=string&maxResults=0Lists all subscriptions created in an Amazon Q Business application.
  • POSTCreate subscription/applications/:applicationId/subscriptionsSubscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers:…
  • POSTCreate user/applications/:applicationId/usersCreates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
  • DELETEDelete attachment/applications/:applicationId/conversations/:conversationId/attachments/:attachmentId?userId=stringDeletes an attachment associated with a specific Amazon Q Business conversation.
  • GETGet chat controls configuration/applications/:applicationId/chatcontrols?maxResults=0&nextToken=stringGets information about chat controls configured for an existing Amazon Q Business application.
  • DELETEDelete chat controls configuration/applications/:applicationId/chatcontrolsDeletes chat controls configured for an existing Amazon Q Business application.
  • PATCHUpdate chat controls configuration/applications/:applicationId/chatcontrolsUpdates a set of chat controls configured for an existing Amazon Q Business application.
  • GETGet chat response configuration/applications/:applicationId/chatresponseconfigurations/:chatResponseConfigurationIdRetrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete…
  • PUTUpdate chat response configuration/applications/:applicationId/chatresponseconfigurations/:chatResponseConfigurationIdUpdates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings,…
  • DELETEDelete chat response configuration/applications/:applicationId/chatresponseconfigurations/:chatResponseConfigurationIdDeletes a specified chat response configuration from an Amazon Q Business application.
  • GETList messages/applications/:applicationId/conversations/:conversationId?userId=string&nextToken=string&maxResults=0Gets a list of messages associated with an Amazon Q Business web experience.
  • DELETEDelete conversation/applications/:applicationId/conversations/:conversationId?userId=stringDeletes an Amazon Q Business web experience conversation.
  • GETGet group/applications/:applicationId/indices/:indexId/groups/:groupName?dataSourceId=stringDescribes a group by group name.
  • DELETEDelete group/applications/:applicationId/indices/:indexId/groups/:groupName?dataSourceId=stringDeletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after…
  • GETGet user/applications/:applicationId/users/:userIdDescribes the universally unique identifier (UUID) associated with a local user in a data source.
  • PUTUpdate user/applications/:applicationId/users/:userIdUpdates a information associated with a user id.
  • DELETEDelete user/applications/:applicationId/users/:userIdDeletes a user by email id.
  • DELETEDisassociate permission/applications/:applicationId/policy/:statementIdRemoves a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation…
  • GETGet document content/applications/:applicationId/index/:indexId/documents/:documentId/content?dataSourceId=string&outputFormat=stringRetrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a…
  • GETGet media/applications/:applicationId/conversations/:conversationId/messages/:messageId/media/:mediaIdReturns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled…
  • GETList attachments/applications/:applicationId/attachments?conversationId=string&userId=string&nextToken=string&maxResults=0Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business…
  • GETList data source sync jobs/applications/:applicationId/indices/:indexId/datasources/:dataSourceId/syncjobs?nextToken=string&maxResults=0&startTime=string&endTime=string&syncStatus=stringGet information about an Amazon Q Business data source connector synchronization.
  • GETList documents/applications/:applicationId/index/:indexId/documents?dataSourceIds=&nextToken=string&maxResults=0A list of documents attached to an index.
  • GETList groups/applications/:applicationId/indices/:indexId/groups?updatedEarlierThan=string&dataSourceId=string&nextToken=string&maxResults=0Provides a list of groups that are mapped to users.
  • PUTPut group/applications/:applicationId/indices/:indexId/groupsCreate, or updates, a mapping of users—who have access to a document—to groups. You can also map sub groups to groups. For example, the group "Company…
  • GETList plugin actions/applications/:applicationId/plugins/:pluginId/actions?nextToken=string&maxResults=0Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
  • GETList plugin type actions/pluginTypes/:pluginType/actions?nextToken=string&maxResults=0Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.
  • GETList plugin type metadata/pluginTypeMetadata?nextToken=string&maxResults=0Lists metadata for all Amazon Q Business plugin types.
  • GETList tags for resource/v1/tags/:resourceARNGets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
  • POSTTag resource/v1/tags/:resourceARNAdds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with…
  • DELETEUntag resource/v1/tags/:resourceARN?tagKeys=Removes a tag from an Amazon Q Business application or a data source.
  • POSTPut feedback/applications/:applicationId/conversations/:conversationId/messages/:messageId/feedback?userId=stringEnables your end user to provide feedback on their Amazon Q Business generated chat responses.
  • POSTSearch relevant content/applications/:applicationId/relevant-contentSearches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application…
  • POSTStart data source sync job/applications/:applicationId/indices/:indexId/datasources/:dataSourceId/startsyncStarts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException .
  • POSTStop data source sync job/applications/:applicationId/indices/:indexId/datasources/:dataSourceId/stopsyncStops an Amazon Q Business data source connector synchronization job already in progress.

API details

Base URL
https://qbusiness.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
82 operations on 45 pathsGET 34POST 20DELETE 16PUT 11PATCH 1
Main resources
Application 5Data accessor 5Data source 5Index 5Plugin 5Retriever 5Web experience 5
Description format
AWS Smithy model, API version 2023-11-27

How to test the QBusiness in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the QBusiness collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “List applications” (GET /applications?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 QBusiness?

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within… It is listed under Developer tools and has 82 endpoints.

Who publishes the QBusiness?

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 QBusiness?

Requests go to https://qbusiness.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the QBusiness?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the QBusiness have?

82 operations on 45 paths (34 GET, 20 POST, 16 DELETE, 11 PUT, 1 PATCH). The largest groups are Application, Data accessor, Data source, Index.

Is forking the QBusiness free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.