Amazon Web Services, Inc.

QApps

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific…

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

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User Guide . For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations . For information about the IAM access control permissions you need to use the Amazon Q Apps API, see IAM role for the Amazon Q Business web experience including Amazon Q Apps in the Amazon Q Business User Guide .

Endpoints 35

  • POSTAssociate library item review/catalog.associateItemRatingAssociates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.
  • POSTAssociate q app with user/apps.installThis operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the…
  • POSTBatch create category/catalog.createCategoriesCreates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more…
  • POSTBatch delete category/catalog.deleteCategoriesDeletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more…
  • POSTBatch update category/catalog.updateCategoriesUpdates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more…
  • POSTCreate library item/catalog.createItemCreates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
  • POSTCreate presigned url/apps.createPresignedUrlCreates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to…
  • POSTCreate q app/apps.createCreates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates…
  • POSTDelete library item/catalog.deleteItemDeletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.
  • POSTDelete q app/apps.deleteDeletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.
  • GETDescribe q app permissions/apps.describeQAppPermissions?appId=stringDescribes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
  • POSTDisassociate library item review/catalog.disassociateItemRatingRemoves a rating or review previously submitted by the user for a library item.
  • POSTDisassociate q app from user/apps.uninstallDisassociates a Q App from a user removing the user's access to run the Q App.
  • POSTExport q app session data/runtime.exportQAppSessionDataExports the collected data of a Q App data collection session.
  • GETGet library item/catalog.getItem?libraryItemId=string&appId=stringRetrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
  • GETGet q app/apps.get?appId=string&appVersion=0Retrieves the full details of an Q App, including its definition specifying the cards and flow.
  • GETGet q app session/runtime.getQAppSession?sessionId=stringRetrieves the current state and results for an active session of an Amazon Q App.
  • GETGet q app session metadata/runtime.getQAppSessionMetadata?sessionId=stringRetrieves the current configuration of a Q App session.
  • POSTImport document/apps.importDocumentUploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The…
  • GETList categories/catalog.listCategoriesLists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps .
  • GETList library items/catalog.list?limit=0&nextToken=string&categoryId=stringLists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
  • GETList q app session data/runtime.listQAppSessionData?sessionId=stringLists the collected data of a Q App data collection session.
  • GETList q apps/apps.list?limit=0&nextToken=stringLists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user…
  • GETList tags for resource/tags/:resourceARNLists the tags associated with an Amazon Q Apps resource.
  • POSTTag resource/tags/:resourceARNAssociates tags with an Amazon Q Apps resource.
  • DELETEUntag resource/tags/:resourceARN?tagKeys=Disassociates tags from an Amazon Q Apps resource.
  • POSTPredict q app/apps.predictQAppGenerates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call…
  • POSTStart q app session/runtime.startQAppSessionStarts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. Each Q App session will be condensed into a single…
  • POSTStop q app session/runtime.deleteMiniAppRunStops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will…
  • POSTUpdate library item/catalog.updateItemUpdates the library item for an Amazon Q App.
  • POSTUpdate library item metadata/catalog.updateItemMetadataUpdates the verification status of a library item for an Amazon Q App.
  • POSTUpdate q app/apps.updateUpdates an existing Amazon Q App, allowing modifications to its title, description, and definition.
  • POSTUpdate q app permissions/apps.updateQAppPermissionsUpdates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
  • POSTUpdate q app session/runtime.updateQAppSessionUpdates the session for a given Q App sessionId . This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card…
  • POSTUpdate q app session metadata/runtime.updateQAppSessionMetadataUpdates the configuration metadata of a session for a given Q App sessionId .

API details

Base URL
https://data.qapps.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
35 operations on 33 pathsPOST 24GET 10DELETE 1
Description format
AWS Smithy model, API version 2023-11-27

How to test the QApps 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 QApps 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 “Associate library item review” (POST /catalog.associateItemRating), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the QApps?

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific… It is listed under Developer tools and has 35 endpoints.

Who publishes the QApps?

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

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

How do I authenticate with the QApps?

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

How many endpoints does the QApps have?

35 operations on 33 paths (24 POST, 10 GET, 1 DELETE).

Is forking the QApps 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.