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-sessions-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

openapi: 3.2.0
info:
  title: QBusiness Sessions API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 3 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: Sessions
paths:
  /assistants/{assistantId}/sessions:
    post:
      operationId: CreateSession
      summary: Create Session
      description: Creates a session. A session is a contextual container used for generating recommendations. Connect Customer creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSessionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '424':
          description: DependencyFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailedException'
        '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/CreateSessionRequest'
      tags:
      - Sessions
  /assistants/{assistantId}/sessions/{sessionId}:
    get:
      operationId: GetSession
      summary: Get Session
      description: Retrieves information for a specified session.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSessionResponse'
        '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/GetSessionRequest'
      tags:
      - Sessions
    post:
      operationId: UpdateSession
      summary: Update Session
      description: Updates a session. A session is a contextual container used for generating recommendations. Connect Customer updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSessionResponse'
        '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/UpdateSessionRequest'
      tags:
      - Sessions
components:
  schemas:
    UpdateSessionResponse:
      type: object
      properties:
        session:
          $ref: '#/components/schemas/SessionData'
    UpdateSessionRequest:
      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.
        sessionId:
          type: string
          description: The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
        description:
          type: string
          description: The description.
        tagFilter:
          $ref: '#/components/schemas/TagFilter'
        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 should be used by Amazon Q in Connect for this Session.
        orchestratorConfigurationList:
          type: array
          items:
            $ref: '#/components/schemas/OrchestratorConfigurationEntry'
          description: The updated list of orchestrator configurations for the session.
        removeOrchestratorConfigurationList:
          type: boolean
          description: The list of orchestrator configurations to remove from the session.
      required:
      - assistantId
      - sessionId
    WisdomAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    OrCondition:
      type: object
      properties:
        andConditions:
          type: array
          items:
            $ref: '#/components/schemas/TagCondition'
          description: A list of conditions which would be applied together with an AND condition.
        tagCondition:
          $ref: '#/components/schemas/TagCondition'
      description: Exactly one member is set.
    WisdomValidationException:
      type: object
      properties:
        message:
          type: string
    TagCondition:
      type: object
      properties:
        key:
          type: string
          description: The tag key in the tag condition.
        value:
          type: string
          description: The tag value in the tag condition.
      required:
      - key
    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
    TagFilter:
      type: object
      properties:
        tagCondition:
          $ref: '#/components/schemas/TagCondition'
        andConditions:
          type: array
          items:
            $ref: '#/components/schemas/TagCondition'
          description: A list of conditions which would be applied together with an AND condition.
        orConditions:
          type: array
          items:
            $ref: '#/components/schemas/OrCondition'
          description: A list of conditions which would be applied together with an OR condition.
      description: Exactly one member is set.
    CreateSessionResponse:
      type: object
      properties:
        session:
          $ref: '#/components/schemas/SessionData'
    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
    DependencyFailedException:
      type: object
      properties:
        message:
          type: string
    SessionData:
      type: object
      properties:
        sessionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the session.
        sessionId:
          type: string
          description: The identifier of the session.
        name:
          type: string
          description: The name of the session.
        description:
          type: string
          description: The description of the session.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        integrationConfiguration:
          $ref: '#/components/schemas/SessionIntegrationConfiguration'
        tagFilter:
          $ref: '#/components/schemas/TagFilter'
        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 should be used by Amazon Q in Connect for this Session.
        origin:
          type: string
          description: The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
        orchestratorConfigurationList:
          type: array
          items:
            $ref: '#/components/schemas/OrchestratorConfigurationEntry'
          description: The list of orchestrator configurations for the session.
      required:
      - sessionArn
      - sessionId
      - name
    WisdomConflictException:
      type: object
      properties:
        message:
          type: string
    CreateSessionRequest:
      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.
        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.
        name:
          type: string
          description: The name of the session.
        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.
        tagFilter:
          $ref: '#/components/schemas/TagFilter'
        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 should be used by Amazon Q in Connect for this Session.
        contactArn:
          type: string
          description: The Amazon Resource Name (ARN) of the email contact in Connect Customer. Used to retrieve email content and establish session context for AI-powered email assistance.
        orchestratorConfigurationList:
          type: array
          items:
            $ref: '#/components/schemas/OrchestratorConfigurationEntry'
          description: The list of orchestrator configurations for the session being created.
        removeOrchestratorConfigurationList:
          type: boolean
          description: The list of orchestrator configurations to remove from the session.
      required:
      - assistantId
      - name
    GetSessionRequest:
      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.
        sessionId:
          type: string
          description: The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantId
      - sessionId
    SessionIntegrationConfiguration:
      type: object
      properties:
        topicIntegrationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
    GetSessionResponse:
      type: object
      properties:
        session:
          $ref: '#/components/schemas/SessionData'
  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)