Amazon Bedrock Foundation Models API

Operations for listing and describing foundation models.

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 2

GET /foundation-models/{modelIdentifier} Get Foundation Model #
GET /foundation-models List Foundation Models #

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-bedrock:amazon-bedrock-foundation-models-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.

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

OpenAPI Specification

amazon-bedrock-foundation-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Bedrock Foundation Models API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 2 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://bedrock.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /foundation-models/{modelIdentifier}:
    get:
      operationId: GetFoundationModel
      summary: Get Foundation Model
      description: Get details about a Amazon Bedrock foundation model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFoundationModelResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFoundationModelRequest'
      tags:
      - Foundation Models
  /foundation-models:
    get:
      operationId: ListFoundationModels
      summary: List Foundation Models
      description: Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters.
        For more information, see Foundation models in the Amazon Bedrock User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFoundationModelsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFoundationModelsRequest'
      tags:
      - Foundation Models
components:
  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: bedrock
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    FoundationModelDetails:
      type: object
      properties:
        modelArn:
          type: string
          description: The model Amazon Resource Name (ARN).
        modelId:
          type: string
          description: The model identifier.
        modelName:
          type: string
          description: The model name.
        providerName:
          type: string
          description: The model's provider name.
        inputModalities:
          type: array
          items:
            type: string
            enum:
            - TEXT
            - IMAGE
            - EMBEDDING
          description: The input modalities that the model supports.
        outputModalities:
          type: array
          items:
            type: string
            enum:
            - TEXT
            - IMAGE
            - EMBEDDING
          description: The output modalities that the model supports.
        responseStreamingSupported:
          type: boolean
          description: Indicates whether the model supports streaming.
        customizationsSupported:
          type: array
          items:
            type: string
            enum:
            - FINE_TUNING
            - CONTINUED_PRE_TRAINING
            - DISTILLATION
          description: The customization that the model supports.
        inferenceTypesSupported:
          type: array
          items:
            type: string
            enum:
            - ON_DEMAND
            - PROVISIONED
          description: The inference types that the model supports.
        modelLifecycle:
          $ref: '#/components/schemas/FoundationModelLifecycle'
      required:
      - modelArn
      - modelId
    FoundationModelLifecycle:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - LEGACY
          description: Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.
        startOfLifeTime:
          type: string
          format: date-time
          description: Launch time when the model first becomes available
        endOfLifeTime:
          type: string
          format: date-time
          description: Time when the model is no longer available for use
        legacyTime:
          type: string
          format: date-time
          description: Time when the model enters legacy state. Models in legacy state can still be used, but users should
            plan to transition to an Active model before the end of life time
        publicExtendedAccessTime:
          type: string
          format: date-time
          description: Public extended access portion of the legacy period, when users should expect higher pricing
      required:
      - status
    FoundationModelSummary:
      type: object
      properties:
        modelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the foundation model.
        modelId:
          type: string
          description: The model ID of the foundation model.
        modelName:
          type: string
          description: The name of the model.
        providerName:
          type: string
          description: The model's provider name.
        inputModalities:
          type: array
          items:
            type: string
            enum:
            - TEXT
            - IMAGE
            - EMBEDDING
          description: The input modalities that the model supports.
        outputModalities:
          type: array
          items:
            type: string
            enum:
            - TEXT
            - IMAGE
            - EMBEDDING
          description: The output modalities that the model supports.
        responseStreamingSupported:
          type: boolean
          description: Indicates whether the model supports streaming.
        customizationsSupported:
          type: array
          items:
            type: string
            enum:
            - FINE_TUNING
            - CONTINUED_PRE_TRAINING
            - DISTILLATION
          description: Whether the model supports fine-tuning or continual pre-training.
        inferenceTypesSupported:
          type: array
          items:
            type: string
            enum:
            - ON_DEMAND
            - PROVISIONED
          description: The inference types that the model supports.
        modelLifecycle:
          $ref: '#/components/schemas/FoundationModelLifecycle'
      required:
      - modelArn
      - modelId
    GetFoundationModelRequest:
      type: object
      properties:
        modelIdentifier:
          type: string
          description: The model identifier.
      required:
      - modelIdentifier
    GetFoundationModelResponse:
      type: object
      properties:
        modelDetails:
          $ref: '#/components/schemas/FoundationModelDetails'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListFoundationModelsRequest:
      type: object
      properties:
        byProvider:
          type: string
          description: Return models belonging to the model provider that you specify.
        byCustomizationType:
          type: string
          enum:
          - FINE_TUNING
          - CONTINUED_PRE_TRAINING
          - DISTILLATION
          description: Return models that support the customization type that you specify. For more information, see Custom
            models in the Amazon Bedrock User Guide.
        byOutputModality:
          type: string
          enum:
          - TEXT
          - IMAGE
          - EMBEDDING
          description: Return models that support the output modality that you specify.
        byInferenceType:
          type: string
          enum:
          - ON_DEMAND
          - PROVISIONED
          description: Return models that support the inference type that you specify. For more information, see Provisioned
            Throughput in the Amazon Bedrock User Guide.
    ListFoundationModelsResponse:
      type: object
      properties:
        modelSummaries:
          type: array
          items:
            $ref: '#/components/schemas/FoundationModelSummary'
          description: A list of Amazon Bedrock foundation models.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)