Amazon Lex Builtins API

The builtins API from Amazon Lex — 2 operation(s) for builtins.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /builtins/intents/{signature} Get Builtin Intent #
GET /builtins/intents Get Builtin Intents #
GET /builtins/slottypes Get Builtin Slot Types #
POST /builtins/locales/{localeId}/intents List built-in intents for a locale · List Built In Intents #
Ask an LLM
“What ready-made intents does Amazon Lex offer for a language?”
“Can I base my own intent on a built-in one, and where do I find its signature?”
Tell an agent
List the built-in intents available in locale {localeId}.
Show built-in intent signatures for {localeId} sorted by {sortBy}.
POST /builtins/locales/{localeId}/slottypes List built-in slot types for a locale · List Built In Slot Types #
Ask an LLM
“Which built-in slot types like dates or numbers are available for a language?”
“Are there predefined slot types I can use without creating my own?”
Tell an agent
List the built-in slot types for locale {localeId}.
Show the first {maxResults} predefined slot types in {localeId}.

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-lex:amazon-lex-builtins-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-lex-builtins-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Lex Model Building V2 Builtins API
  version: '2020-08-07'
  description: Generated from AWS's published Smithy model for Amazon Lex Model Building V2. 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://models.lex.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /builtins/intents/{signature}:
    get:
      operationId: GetBuiltinIntent
      summary: Get Builtin Intent
      description: Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBuiltinIntentResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBuiltinIntentRequest'
      tags:
      - Builtins
  /builtins/intents:
    get:
      operationId: GetBuiltinIntents
      summary: Get Builtin Intents
      description: Gets a list of built-in intents that meet the specified criteria. This operation requires permission for
        the lex:GetBuiltinIntents action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBuiltinIntentsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBuiltinIntentsRequest'
      tags:
      - Builtins
  /builtins/slottypes:
    get:
      operationId: GetBuiltinSlotTypes
      summary: Get Builtin Slot Types
      description: Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types,
        see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBuiltinSlotTypesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBuiltinSlotTypesRequest'
      tags:
      - Builtins
  /builtins/locales/{localeId}/intents:
    post:
      operationId: ListBuiltInIntents
      summary: List Built In Intents
      description: Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. To use a built-in
        intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter
        when you call the CreateIntent operation. For more information, see CreateIntent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBuiltInIntentsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/ListBuiltInIntentsRequest'
      tags:
      - Builtins
      servers:
      - url: https://models-v2-lex.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
  /builtins/locales/{localeId}/slottypes:
    post:
      operationId: ListBuiltInSlotTypes
      summary: List Built In Slot Types
      description: Gets a list of built-in slot types that meet the specified criteria.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBuiltInSlotTypesResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/ListBuiltInSlotTypesRequest'
      tags:
      - Builtins
      servers:
      - url: https://models-v2-lex.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
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: lex
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    BuiltInIntentSortBy:
      type: object
      properties:
        attribute:
          type: string
          enum:
          - IntentSignature
          description: The attribute to use to sort the list of built-in intents.
        order:
          type: string
          enum:
          - Ascending
          - Descending
          description: The order to sort the list. You can specify ascending or descending order.
      required:
      - attribute
      - order
    BuiltInIntentSummary:
      type: object
      properties:
        intentSignature:
          type: string
          description: The signature of the built-in intent. Use this to specify the parent intent of a derived intent.
        description:
          type: string
          description: The description of the intent.
    BuiltInSlotTypeSortBy:
      type: object
      properties:
        attribute:
          type: string
          enum:
          - SlotTypeSignature
          description: The attribute to use to sort the list of built-in intents.
        order:
          type: string
          enum:
          - Ascending
          - Descending
          description: The order to sort the list. You can choose ascending or descending.
      required:
      - attribute
      - order
    BuiltInSlotTypeSummary:
      type: object
      properties:
        slotTypeSignature:
          type: string
          description: The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot
            type.
        description:
          type: string
          description: The description of the built-in slot type.
    BuiltinIntentMetadata:
      type: object
      properties:
        signature:
          type: string
          description: A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in
            Intents in the Alexa Skills Kit.
        supportedLocales:
          type: array
          items:
            type: string
            enum:
            - de-DE
            - en-AU
            - en-GB
            - en-IN
            - en-US
            - es-419
            - es-ES
            - es-US
            - fr-FR
            - fr-CA
            - it-IT
            - ja-JP
            - ko-KR
          description: A list of identifiers for the locales that the intent supports.
    BuiltinIntentSlot:
      type: object
      properties:
        name:
          type: string
          description: A list of the slots defined for the intent.
    BuiltinSlotTypeMetadata:
      type: object
      properties:
        signature:
          type: string
          description: A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type
            Reference in the Alexa Skills Kit.
        supportedLocales:
          type: array
          items:
            type: string
            enum:
            - de-DE
            - en-AU
            - en-GB
            - en-IN
            - en-US
            - es-419
            - es-ES
            - es-US
            - fr-FR
            - fr-CA
            - it-IT
            - ja-JP
            - ko-KR
          description: A list of target locales for the slot.
    GetBuiltinIntentRequest:
      type: object
      properties:
        signature:
          type: string
          description: The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in
            Intents in the Alexa Skills Kit.
      required:
      - signature
    GetBuiltinIntentResponse:
      type: object
      properties:
        signature:
          type: string
          description: The unique identifier for a built-in intent.
        supportedLocales:
          type: array
          items:
            type: string
            enum:
            - de-DE
            - en-AU
            - en-GB
            - en-IN
            - en-US
            - es-419
            - es-ES
            - es-US
            - fr-FR
            - fr-CA
            - it-IT
            - ja-JP
            - ko-KR
          description: A list of locales that the intent supports.
        slots:
          type: array
          items:
            $ref: '#/components/schemas/BuiltinIntentSlot'
          description: An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
    GetBuiltinIntentsRequest:
      type: object
      properties:
        locale:
          type: string
          enum:
          - de-DE
          - en-AU
          - en-GB
          - en-IN
          - en-US
          - es-419
          - es-ES
          - es-US
          - fr-FR
          - fr-CA
          - it-IT
          - ja-JP
          - ko-KR
          description: A list of locales that the intent supports.
        signatureContains:
          type: string
          description: Substring to match in built-in intent signatures. An intent will be returned if any part of its signature
            matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent,
            see Standard Built-in Intents in the Alexa Skills Kit.
        nextToken:
          type: string
          description: A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex
            returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the
            next request.
        maxResults:
          type: integer
          description: The maximum number of intents to return in the response. The default is 10.
    GetBuiltinIntentsResponse:
      type: object
      properties:
        intents:
          type: array
          items:
            $ref: '#/components/schemas/BuiltinIntentMetadata'
          description: An array of builtinIntentMetadata objects, one for each intent in the response.
        nextToken:
          type: string
          description: A pagination token that fetches the next page of intents. If the response to this API call is truncated,
            Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination
            token in the next request.
    GetBuiltinSlotTypesRequest:
      type: object
      properties:
        locale:
          type: string
          enum:
          - de-DE
          - en-AU
          - en-GB
          - en-IN
          - en-US
          - es-419
          - es-ES
          - es-US
          - fr-FR
          - fr-CA
          - it-IT
          - ja-JP
          - ko-KR
          description: A list of locales that the slot type supports.
        signatureContains:
          type: string
          description: Substring to match in built-in slot type signatures. A slot type will be returned if any part of its
            signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
        nextToken:
          type: string
          description: A pagination token that fetches the next page of slot types. If the response to this API call is truncated,
            Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination
            token in the next request.
        maxResults:
          type: integer
          description: The maximum number of slot types to return in the response. The default is 10.
    GetBuiltinSlotTypesResponse:
      type: object
      properties:
        slotTypes:
          type: array
          items:
            $ref: '#/components/schemas/BuiltinSlotTypeMetadata'
          description: An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.
        nextToken:
          type: string
          description: If the response is truncated, the response includes a pagination token that you can use in your next
            request to fetch the next page of slot types.
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    ListBuiltInIntentsRequest:
      type: object
      properties:
        localeId:
          type: string
          description: The identifier of the language and locale of the intents to list. The string must match one of the
            supported locales. For more information, see Supported languages.
        sortBy:
          $ref: '#/components/schemas/BuiltInIntentSortBy'
        maxResults:
          type: integer
          description: The maximum number of built-in intents to return in each page of results. If there are fewer results
            than the max page size, only the actual number of results are returned.
        nextToken:
          type: string
          description: If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults
            parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page
            of results.
      required:
      - localeId
    ListBuiltInIntentsResponse:
      type: object
      properties:
        builtInIntentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/BuiltInIntentSummary'
          description: Summary information for the built-in intents that meet the filter criteria specified in the request.
            The length of the list is specified in the maxResults parameter of the request. If there are more intents available,
            the nextToken field contains a token to get the next page of results.
        nextToken:
          type: string
          description: A token that indicates whether there are more results to return in a response to the ListBuiltInIntents
            operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases
            operation request to get the next page of results.
        localeId:
          type: string
          description: The language and locale of the intents in the list.
    ListBuiltInSlotTypesRequest:
      type: object
      properties:
        localeId:
          type: string
          description: The identifier of the language and locale of the slot types to list. The string must match one of the
            supported locales. For more information, see Supported languages.
        sortBy:
          $ref: '#/components/schemas/BuiltInSlotTypeSortBy'
        maxResults:
          type: integer
          description: The maximum number of built-in slot types to return in each page of results. If there are fewer results
            than the max page size, only the actual number of results are returned.
        nextToken:
          type: string
          description: If the response from the ListBuiltInSlotTypes operation contains more results than specified in the
            maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return
            the next page of results.
      required:
      - localeId
    ListBuiltInSlotTypesResponse:
      type: object
      properties:
        builtInSlotTypeSummaries:
          type: array
          items:
            $ref: '#/components/schemas/BuiltInSlotTypeSummary'
          description: Summary information for the built-in slot types that meet the filter criteria specified in the request.
            The length of the list is specified in the maxResults parameter of the request. If there are more slot types available,
            the nextToken field contains a token to get the next page of results.
        nextToken:
          type: string
          description: A token that indicates whether there are more results to return in a response to the ListBuiltInSlotTypes
            operation. If the nextToken field is present, you send the contents as the nextToken parameter of a LIstBuiltInSlotTypes
            operation request to get the next page of results.
        localeId:
          type: string
          description: The language and locale of the slot types in the list.
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        retryAfterSeconds:
          type: integer
          description: The number of seconds after which the user can invoke the API again.
        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/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json