openapi: 3.0.3
info:
  title: Amazon Q Business API
  description: Amazon Q Business is a generative AI-powered enterprise assistant that enables employees to ask questions, get summaries, generate content, and take actions using enterprise data.
  version: 2023-11-27
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://qbusiness.{region}.amazonaws.com
    variables:
      region:
        default: us-east-1
        description: AWS region
components:
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
  schemas:
    Application:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q application.
        displayName:
          type: string
          description: The name of the Amazon Q application.
        status:
          type: string
          enum: [CREATING, ACTIVE, DELETING, FAILED, UPDATING]
          description: The status of the Amazon Q application.
        createdAt:
          type: string
          format: date-time
          description: The date and time the application was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the application was last updated.
    Conversation:
      type: object
      properties:
        conversationId:
          type: string
          description: The unique identifier of the conversation.
        title:
          type: string
          description: The title of the conversation.
        createdAt:
          type: string
          format: date-time
          description: The date and time the conversation was created.
    Message:
      type: object
      properties:
        messageId:
          type: string
          description: The unique identifier of the message.
        body:
          type: string
          description: The content of the message.
        type:
          type: string
          enum: [USER, SYSTEM]
          description: The type of message.
        time:
          type: string
          format: date-time
          description: The time the message was sent.
    DataSource:
      type: object
      properties:
        dataSourceId:
          type: string
          description: The unique identifier of the data source.
        displayName:
          type: string
          description: The name of the data source.
        type:
          type: string
          description: The type of data source connector.
        status:
          type: string
          enum: [PENDING_CREATION, CREATING, ACTIVE, DELETING, UPDATING, NEEDS_ATTENTION, FAILED]
          description: The status of the data source.
    Index:
      type: object
      properties:
        indexId:
          type: string
          description: The unique identifier of the index.
        displayName:
          type: string
          description: The name of the index.
        status:
          type: string
          enum: [CREATING, ACTIVE, DELETING, FAILED, UPDATING]
          description: The status of the index.
security:
  - sigv4: []
paths:
  /applications:
    get:
      operationId: ListApplications
      summary: List Applications
      description: Lists Amazon Q Business applications.
      tags: [Applications]
      parameters:
        - name: maxResults
          in: query
          schema:
            type: integer
        - name: nextToken
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Success
    post:
      operationId: CreateApplication
      summary: Create Application
      description: Creates an Amazon Q Business application.
      tags: [Applications]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [displayName]
              properties:
                displayName:
                  type: string
                description:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
  /applications/{applicationId}:
    get:
      operationId: GetApplication
      summary: Get Application
      description: Gets information about an Amazon Q Business application.
      tags: [Applications]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
    delete:
      operationId: DeleteApplication
      summary: Delete Application
      description: Deletes an Amazon Q Business application.
      tags: [Applications]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
  /applications/{applicationId}/conversations:
    get:
      operationId: ListConversations
      summary: List Conversations
      description: Lists one or more Amazon Q Business conversations.
      tags: [Conversations]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
    post:
      operationId: ChatSync
      summary: Chat Sync
      description: Starts or continues a synchronous Amazon Q Business conversation.
      tags: [Conversations]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userMessage:
                  type: string
                conversationId:
                  type: string
      responses:
        '200':
          description: Success
  /applications/{applicationId}/datasources:
    get:
      operationId: ListDataSources
      summary: List Data Sources
      description: Lists Amazon Q Business data sources for a retriever-based application.
      tags: [Data Sources]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
        - name: indexId
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
    post:
      operationId: CreateDataSource
      summary: Create Data Source
      description: Creates a data source connector for an Amazon Q Business application.
      tags: [Data Sources]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSource'
      responses:
        '200':
          description: Success
  /applications/{applicationId}/indices:
    get:
      operationId: ListIndices
      summary: List Indices
      description: Lists the Amazon Q Business indices you have created.
      tags: [Indices]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
    post:
      operationId: CreateIndex
      summary: Create Index
      description: Creates an Amazon Q Business index.
      tags: [Indices]
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [displayName]
              properties:
                displayName:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'