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-aiprompts-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 Aiprompts API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 5 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: Aiprompts
paths:
  /assistants/{assistantId}/aiprompts:
    post:
      operationId: CreateAIPrompt
      summary: Create AIPrompt
      description: Creates an Amazon Q in Connect AI Prompt.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAIPromptResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomServiceQuotaExceededException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAIPromptRequest'
      tags:
      - Aiprompts
    get:
      operationId: ListAIPrompts
      summary: List AIPrompts
      description: Lists the AI Prompts available on the Amazon Q in Connect assistant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAIPromptsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAIPromptsRequest'
      tags:
      - Aiprompts
  /assistants/{assistantId}/aiprompts/{aiPromptId}:
    get:
      operationId: GetAIPrompt
      summary: Get AIPrompt
      description: Gets and Amazon Q in Connect AI Prompt.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAIPromptResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAIPromptRequest'
      tags:
      - Aiprompts
    post:
      operationId: UpdateAIPrompt
      summary: Update AIPrompt
      description: Updates an AI Prompt.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAIPromptResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAIPromptRequest'
      tags:
      - Aiprompts
    delete:
      operationId: DeleteAIPrompt
      summary: Delete AIPrompt
      description: Deletes an Amazon Q in Connect AI Prompt.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAIPromptResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAIPromptRequest'
      tags:
      - Aiprompts
components:
  schemas:
    DeleteAIPromptRequest:
      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.
        aiPromptId:
          type: string
          description: The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantId
      - aiPromptId
    WisdomAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ListAIPromptsResponse:
      type: object
      properties:
        aiPromptSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AIPromptSummary'
          description: The summaries of the AI Prompts.
        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.
      required:
      - aiPromptSummaries
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    AIPromptTemplateConfiguration:
      type: object
      properties:
        textFullAIPromptEditTemplateConfiguration:
          $ref: '#/components/schemas/TextFullAIPromptEditTemplateConfiguration'
      description: Exactly one member is set.
    DeleteAIPromptResponse:
      type: object
      properties: {}
    UpdateAIPromptRequest:
      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.
        aiPromptId:
          type: string
          description: The identifier of the Amazon Q in Connect AI Prompt.
        visibilityStatus:
          type: string
          description: The visibility status of the Amazon Q in Connect AI prompt.
        templateConfiguration:
          $ref: '#/components/schemas/AIPromptTemplateConfiguration'
        description:
          type: string
          description: The description of the Amazon Q in Connect AI Prompt.
        modelId:
          type: string
          description: The identifier of the model used for this AI Prompt. For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.
        inferenceConfiguration:
          $ref: '#/components/schemas/AIPromptInferenceConfiguration'
      required:
      - assistantId
      - aiPromptId
      - visibilityStatus
    WisdomServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    UpdateAIPromptResponse:
      type: object
      properties:
        aiPrompt:
          $ref: '#/components/schemas/AIPromptData'
    ListAIPromptsRequest:
      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.
        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.
        origin:
          type: string
          description: The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
      required:
      - assistantId
    GetAIPromptResponse:
      type: object
      properties:
        aiPrompt:
          $ref: '#/components/schemas/AIPromptData'
        versionNumber:
          type: integer
          description: The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).
    TextFullAIPromptEditTemplateConfiguration:
      type: object
      properties:
        text:
          type: string
          description: The YAML text for the AI Prompt template.
      required:
      - text
    AIPromptData:
      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.
        assistantArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        aiPromptId:
          type: string
          description: The identifier of the Amazon Q in Connect AI prompt.
        aiPromptArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AI Prompt.
        name:
          type: string
          description: The name of the AI Prompt
        type:
          type: string
          description: The type of this AI Prompt.
        templateType:
          type: string
          description: The type of the prompt template for this AI Prompt.
        modelId:
          type: string
          description: 'The identifier of the model used for this AI Prompt. The following model Ids are supported: anthropic.claude-3-haiku--v1:0 apac.amazon.nova-lite-v1:0 apac.amazon.nova-micro-v1:0 apac.amazon.nova-pro-v1:0 apac.anthropic.claude-3-5-sonnet--v2:0 apac.anthropic.claude-3-haiku-20240307-v1:0 eu.amazon.nova-lite-v1:0 eu.amazon.nova-micro-v1:0 eu.amazon.nova-pro-v1:0 eu.anthropic.claude-3-7-sonnet-20250219-v1:0 eu.anthropic.claude-3-haiku-20240307-v1:0 us.amazon.nova-lite-v1:0 us.amazon.nova-micro-v1:0 us.amazon.nova-pro-v1:0 us.anthropic.claude-3-5-haiku-20241022-v1:0 us.anthropic.claude-3-7-sonnet-2'
        apiFormat:
          type: string
          description: The API format used for this AI Prompt.
        templateConfiguration:
          $ref: '#/components/schemas/AIPromptTemplateConfiguration'
        inferenceConfiguration:
          $ref: '#/components/schemas/AIPromptInferenceConfiguration'
        modifiedTime:
          type: string
          description: The time the AI Prompt was last modified.
        description:
          type: string
          description: The description of the AI Prompt.
        visibilityStatus:
          type: string
          description: The visibility status of the AI Prompt.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        origin:
          type: string
          description: The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
        status:
          type: string
          description: The status of the AI Prompt.
      required:
      - assistantId
      - assistantArn
      - aiPromptId
      - aiPromptArn
      - name
      - type
      - templateType
      - modelId
      - apiFormat
      - templateConfiguration
      - visibilityStatus
    WisdomConflictException:
      type: object
      properties:
        message:
          type: string
    GetAIPromptRequest:
      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.
        aiPromptId:
          type: string
          description: The identifier of the Amazon Q in Connect AI prompt.
      required:
      - assistantId
      - aiPromptId
    AIPromptInferenceConfiguration:
      type: object
      properties:
        temperature:
          type: number
          description: The temperature setting for controlling randomness in the generated response.
        topP:
          type: number
          description: The top-P sampling parameter for nucleus sampling.
        topK:
          type: integer
          description: The top-K sampling parameter for token selection.
        maxTokensToSample:
          type: integer
          description: The maximum number of tokens to generate in the response.
    CreateAIPromptResponse:
      type: object
      properties:
        aiPrompt:
          $ref: '#/components/schemas/AIPromptData'
    WisdomThrottlingException:
      type: object
      properties:
        message:
          type: string
    CreateAIPromptRequest:
      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 AI Prompt.
        type:
          type: string
          description: The type of this AI Prompt.
        templateConfiguration:
          $ref: '#/components/schemas/AIPromptTemplateConfiguration'
        visibilityStatus:
          type: string
          description: The visibility status of the AI Prompt.
        templateType:
          type: string
          description: The type of the prompt template for this AI Prompt.
        modelId:
          type: string
          description: The identifier of the model used for this AI Prompt. For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.
        apiFormat:
          type: string
          description: 'The API Format of the AI Prompt. Recommended values: MESSAGES | TEXT_COMPLETIONS The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        description:
          type: string
          description: The description of the AI Prompt.
        inferenceConfiguration:
          $ref: '#/components/schemas/AIPromptInferenceConfiguration'
      required:
      - assistantId
      - name
      - type
      - templateConfiguration
      - visibilityStatus
      - templateType
      - modelId
      - apiFormat
    AIPromptSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the AI Prompt.
        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.
        assistantArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        aiPromptId:
          type: string
          description: The identifier of the Amazon Q in Connect AI prompt.
        type:
          type: string
          description: The type of this AI Prompt.
        aiPromptArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AI Prompt.
        modifiedTime:
          type: string
          description: The time the AI Prompt was last modified.
        templateType:
          type: string
          description: The type of the prompt template for this AI Prompt.
        modelId:
          type: string
          description: 'The identifier of the model used for this AI Prompt. Model Ids supported are: anthropic.claude-3-haiku-20240307-v1:0.'
        apiFormat:
          type: string
          description: The API format used for this AI Prompt.
        visibilityStatus:
          type: string
          description: The visibility status of the AI Prompt.
        origin:
          type: string
          description: The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
        description:
          type: string
          description: The description of the AI Prompt.
        status:
          type: string
          description: The status of the AI Prompt.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - name
      - assistantId
      - assistantArn
      - aiPromptId
      - type
      - aiPromptArn
      - templateType
      - modelId
      - apiFormat
      - visibilityStatus
  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)