Amazon Q

Amazon Q is a generative AI-powered assistant that helps with various tasks including answering questions, generating content, and taking actions based on your enterprise data and systems. It is available in multiple product variants including Amazon Q Business for enterprise knowledge, Amazon Q Developer for software development, and Amazon Q in Connect for customer service agents.

5 APIs 0 Features

Artificial IntelligenceAssistantEnterpriseGenerative AI

APIs

Amazon Q Business API

API for Amazon Q Business, a fully managed generative AI-powered enterprise chat assistant that you can deploy within your organization. It enables employees to ask questions, g...

Amazon Q Business QApps API

API for Amazon Q Apps, a feature within Amazon Q Business that allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks using their ent...

Amazon Q Developer API

API for Amazon Q Developer, the most capable generative AI-powered assistant for software development. It provides inline code suggestions, chat-based coding assistance, securit...

Amazon Q Connect API

API for Amazon Q in Connect, a generative AI-powered customer service assistant integrated with Amazon Connect. It automatically detects customer intent during calls and chats u...

Amazon Q Developer in Chat Applications API

API for Amazon Q Developer in chat applications, which enables integration of Amazon Q Developer capabilities into messaging platforms. It provides descriptions, request paramet...

Collections

Amazon Q Business API

OPEN

Pricing Plans

Amazon Q Plans Pricing

7 plans

PLANS

Rate Limits

Amazon Q Rate Limits

5 limits

RATE LIMITS

FinOps

Amazon Q Finops

FINOPS

Semantic Vocabularies

Amazon Q Openapi Application Context

1 classes · 5 properties

JSON-LD

Amazon Q Openapi Conversation Context

1 classes · 3 properties

JSON-LD

Amazon Q Openapi Data Source Context

1 classes · 4 properties

JSON-LD

Amazon Q Openapi Index Context

1 classes · 3 properties

JSON-LD

Amazon Q Openapi Message Context

1 classes · 4 properties

JSON-LD

API Governance Rules

Amazon Q API Rules

19 rules · 8 errors 10 warnings 1 info

SPECTRAL

JSON Structure

Amazon Q Openapi Application Structure

5 properties

JSON STRUCTURE

Amazon Q Openapi Conversation Structure

3 properties

JSON STRUCTURE

Amazon Q Openapi Data Source Structure

4 properties

JSON STRUCTURE

Amazon Q Openapi Index Structure

3 properties

JSON STRUCTURE

Amazon Q Openapi Message Structure

4 properties

JSON STRUCTURE

Amazon Q Structure

0 properties

JSON STRUCTURE

Example Payloads

Amazon Q Openapi Application Example

5 fields

EXAMPLE

Amazon Q Openapi Conversation Example

3 fields

EXAMPLE

Amazon Q Openapi Data Source Example

4 fields

EXAMPLE

Amazon Q Openapi Index Example

3 fields

EXAMPLE

Amazon Q Openapi Message Example

4 fields

EXAMPLE

Resources

GettingStarted

Documentation

TermsOfService

PrivacyPolicy

GitHubOrganization

GitHubOrganization

JSONStructure

JSONStructure

JSONStructure

JSONStructure

JSONStructure

SpectralRules

Sources

opencollection: 1.0.0
info:
  name: Amazon Q Business API
  version: Sun Nov 26 2023 19:00:00 GMT-0500 (Eastern Standard Time)
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Applications
    type: folder
  items:
  - info:
      name: List Applications
      type: http
    http:
      method: GET
      url: https://qbusiness.{region}.amazonaws.com/applications
      params:
      - name: maxResults
        value: ''
        type: query
      - name: nextToken
        value: ''
        type: query
    docs: Lists Amazon Q Business applications.
  - info:
      name: Create Application
      type: http
    http:
      method: POST
      url: https://qbusiness.{region}.amazonaws.com/applications
      body:
        type: json
        data: '{}'
    docs: Creates an Amazon Q Business application.
  - info:
      name: Get Application
      type: http
    http:
      method: GET
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId
      params:
      - name: applicationId
        value: ''
        type: path
    docs: Gets information about an Amazon Q Business application.
  - info:
      name: Delete Application
      type: http
    http:
      method: DELETE
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId
      params:
      - name: applicationId
        value: ''
        type: path
    docs: Deletes an Amazon Q Business application.
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: List Conversations
      type: http
    http:
      method: GET
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId/conversations
      params:
      - name: applicationId
        value: ''
        type: path
    docs: Lists one or more Amazon Q Business conversations.
  - info:
      name: Chat Sync
      type: http
    http:
      method: POST
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId/conversations
      params:
      - name: applicationId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Starts or continues a synchronous Amazon Q Business conversation.
- info:
    name: Data Sources
    type: folder
  items:
  - info:
      name: List Data Sources
      type: http
    http:
      method: GET
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId/datasources
      params:
      - name: applicationId
        value: ''
        type: path
      - name: indexId
        value: ''
        type: query
    docs: Lists Amazon Q Business data sources for a retriever-based application.
  - info:
      name: Create Data Source
      type: http
    http:
      method: POST
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId/datasources
      params:
      - name: applicationId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Creates a data source connector for an Amazon Q Business application.
- info:
    name: Indices
    type: folder
  items:
  - info:
      name: List Indices
      type: http
    http:
      method: GET
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId/indices
      params:
      - name: applicationId
        value: ''
        type: path
    docs: Lists the Amazon Q Business indices you have created.
  - info:
      name: Create Index
      type: http
    http:
      method: POST
      url: https://qbusiness.{region}.amazonaws.com/applications/:applicationId/indices
      params:
      - name: applicationId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Creates an Amazon Q Business index.
bundled: true