Amazon Q

Amazon Q Q Assistants API

The Q Assistants API from Amazon Q — 2 operation(s) for q assistants.

GitHub OpenAPI

Operations 4

POST /assistants Create Assistant #
GET /assistants List Assistants #
GET /assistants/{assistantId} Get Assistant #
DELETE /assistants/{assistantId} Delete Assistant #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-q/openapi/amazon-q-assistants-api-openapi.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-q:amazon-q-assistants-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-q-assistants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: QBusiness Assistants API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 4 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: Assistants
paths:
  /assistants:
    post:
      operationId: CreateAssistant
      summary: Create Assistant
      description: Creates an Amazon Q in Connect assistant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssistantResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '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/CreateAssistantRequest'
      tags:
      - Assistants
    get:
      operationId: ListAssistants
      summary: List Assistants
      description: Lists information about assistants.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssistantsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '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/ListAssistantsRequest'
      tags:
      - Assistants
  /assistants/{assistantId}:
    get:
      operationId: GetAssistant
      summary: Get Assistant
      description: Retrieves information about an assistant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAssistantResponse'
        '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/GetAssistantRequest'
      tags:
      - Assistants
    delete:
      operationId: DeleteAssistant
      summary: Delete Assistant
      description: Deletes an assistant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssistantResponse'
        '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/DeleteAssistantRequest'
      tags:
      - Assistants
components:
  schemas:
    GetAssistantRequest:
      type: object
      properties:
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantId
    CreateAssistantRequest:
      type: object
      properties:
        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.
        name:
          type: string
          description: The name of the assistant.
        type:
          type: string
          description: The type of assistant.
        description:
          type: string
          description: The description of the assistant.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        serverSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
      required:
      - name
      - type
    AssistantIntegrationConfiguration:
      type: object
      properties:
        topicIntegrationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
    WisdomAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    AssistantCapabilityConfiguration:
      type: object
      properties:
        type:
          type: string
          description: The type of Amazon Q in Connect assistant capability.
    GetAssistantResponse:
      type: object
      properties:
        assistant:
          $ref: '#/components/schemas/AssistantData'
    CreateAssistantResponse:
      type: object
      properties:
        assistant:
          $ref: '#/components/schemas/AssistantData'
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    WisdomValidationException:
      type: object
      properties:
        message:
          type: string
    AssistantSummary:
      type: object
      properties:
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant.
        assistantArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        name:
          type: string
          description: The name of the assistant.
        type:
          type: string
          description: The type of the assistant.
        status:
          type: string
          description: The status of the assistant.
        description:
          type: string
          description: The description of the assistant.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        serverSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        integrationConfiguration:
          $ref: '#/components/schemas/AssistantIntegrationConfiguration'
        capabilityConfiguration:
          $ref: '#/components/schemas/AssistantCapabilityConfiguration'
        aiAgentConfiguration:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AIAgentConfigurationData'
          description: The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
        orchestratorConfigurationList:
          type: array
          items:
            $ref: '#/components/schemas/OrchestratorConfigurationEntry'
          description: The list of orchestrator configurations for the assistant.
      required:
      - assistantId
      - assistantArn
      - name
      - type
      - status
    WisdomServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    DeleteAssistantRequest:
      type: object
      properties:
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantId
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    OrchestratorConfigurationEntry:
      type: object
      properties:
        aiAgentId:
          type: string
          description: The identifier of the AI Agent in the orchestrator configuration.
        orchestratorUseCase:
          type: string
          description: The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
      required:
      - orchestratorUseCase
    ListAssistantsResponse:
      type: object
      properties:
        assistantSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AssistantSummary'
          description: Information about the assistants.
        nextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - assistantSummaries
    AIAgentConfigurationData:
      type: object
      properties:
        aiAgentId:
          type: string
          description: The ID of the AI Agent to be configured.
        enabled:
          type: boolean
          description: Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
      required:
      - aiAgentId
    ListAssistantsRequest:
      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.
    AssistantData:
      type: object
      properties:
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant.
        assistantArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        name:
          type: string
          description: The name.
        type:
          type: string
          description: The type of assistant.
        status:
          type: string
          description: The status of the assistant.
        description:
          type: string
          description: The description.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        serverSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        integrationConfiguration:
          $ref: '#/components/schemas/AssistantIntegrationConfiguration'
        capabilityConfiguration:
          $ref: '#/components/schemas/AssistantCapabilityConfiguration'
        aiAgentConfiguration:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AIAgentConfigurationData'
          description: The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
        orchestratorConfigurationList:
          type: array
          items:
            $ref: '#/components/schemas/OrchestratorConfigurationEntry'
          description: The list of orchestrator configurations for the assistant.
      required:
      - assistantId
      - assistantArn
      - name
      - type
      - status
    ServerSideEncryptionConfiguration:
      type: object
      properties:
        kmsKeyId:
          type: string
          description: The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
    WisdomConflictException:
      type: object
      properties:
        message:
          type: string
    DeleteAssistantResponse:
      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)