Amazon Lex

Amazon Lex Bots API

Lex bot management

GitHub OpenAPI

Operations 107

PUT /bots Creates an Amazon Lex conversational bot. #
POST /bots Gets a list of available bots. #
DELETE /bots/{botId} Deletes all versions of a bot, including the Draft version. #
GET /bots/{botId} Provides metadata information about a bot. #
PUT /bots/{botId} Updates the configuration of an existing bot. #
POST /bots/{botId}/aggregatedutterances Provides a list of utterances that users have sent to the bot. #
POST /bots/{botId}/analytics/intentmetrics Retrieves summary metrics for the intents in your bot. #
POST /bots/{botId}/analytics/intentpaths Retrieves summary statistics for a path of intents that users take over sessions with your bot. #
POST /bots/{botId}/analytics/intentstagemetrics Retrieves summary metrics for the stages within intents in your bot. #
POST /bots/{botId}/analytics/sessionmetrics Retrieves summary metrics for the user sessions with your bot. #
POST /bots/{botId}/analytics/sessions Retrieves a list of metadata for individual user sessions with your bot. #
POST /bots/{botId}/analytics/utterancemetrics To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. #
POST /bots/{botId}/analytics/utterances To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. #
PUT /bots/{botId}/botaliases Creates an alias for the specified version of a bot. #
POST /bots/{botId}/botaliases Gets a list of aliases for the specified bot. #
DELETE /bots/{botId}/botaliases/{botAliasId} Deletes the specified bot alias. #
GET /bots/{botId}/botaliases/{botAliasId} Get information about a specific bot alias. #
PUT /bots/{botId}/botaliases/{botAliasId} Updates the configuration of an existing bot alias. #
POST /bots/{botId}/botanalyzer Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices. #
POST /bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId} Retrieves the analysis results and recommendations for bot optimization. #
POST /bots/{botId}/botanalyzer/history Retrieves a list of historical bot analysis executions for a specific bot. #
DELETE /bots/{botId}/botanalyzer/{botAnalyzerRequestId} Permanently deletes the recommendations and analysis results for a specific bot analysis request. #
PUT /bots/{botId}/botanalyzer/{botAnalyzerRequestId}/stop Cancels an ongoing bot analysis execution. #
PUT /bots/{botId}/botversions Creates an immutable version of the bot. #
POST /bots/{botId}/botversions Gets information about all of the versions of a bot. #
DELETE /bots/{botId}/botversions/{botVersion} Deletes a specific version of a bot. #
GET /bots/{botId}/botversions/{botVersion} Provides metadata about a version of a bot. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales Creates a locale in the bot. #
POST /bots/{botId}/botversions/{botVersion}/botlocales Gets a list of locales for the specified bot. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Builds a bot, its intents, and its slot types into a specific locale. #
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Removes a locale from a bot. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Describes the settings that a bot has for a specific locale. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Updates the settings that a bot has for a specific locale. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations Get a list of bot recommendations that meet the specified criteria. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations Use this to provide your transcript data, and to start the bot recommendation process. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId} Provides metadata information about a bot recommendation. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId} Updates an existing bot recommendation request. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts Search for associated transcripts that meet the specified criteria. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation Stop an already running Bot Recommendation request. #
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary Removes a custom vocabulary from the specified locale in the specified bot. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchcreate Create a batch of custom vocabulary items for a given bot locale's custom vocabulary. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchdelete Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate Update a batch of custom vocabulary items for a given bot locale's custom vocabulary. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/list Paginated list of custom vocabulary items for a given bot locale's custom vocabulary. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/metadata Provides metadata information about a custom vocabulary. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generate Generates sample utterances for an intent. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generations Lists the generation requests made for a bot locale. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generations/{generationId} Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents Creates an intent. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents Get a list of intents that meet the specified criteria. #
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId} Removes the specified intent. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId} Returns metadata about an intent. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId} Updates the settings for an intent. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots Creates a slot in an intent. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots Gets a list of slots that match the specified criteria. #
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId} Deletes the specified slot from an intent. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId} Gets metadata information about a slot. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId} Updates the settings for a slot. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume. #
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes Gets a list of slot types that match the specified criteria. #
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId} Deletes a slot type from a bot locale. #
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId} Gets metadata information about a slot type. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId} Updates the configuration of an existing slot type. #
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/startgeneration Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. #
PUT /bots/{botId}/replicas Action to create a replication of the source bot in the secondary region. #
POST /bots/{botId}/replicas The action to list the replicated bots. #
DELETE /bots/{botId}/replicas/{replicaRegion} The action to delete the replicated bot in the secondary region. #
GET /bots/{botId}/replicas/{replicaRegion} Monitors the bot replication status through the UI console. #
POST /bots/{botId}/replicas/{replicaRegion}/botaliases The action to list the replicated bots created from the source bot alias. #
POST /bots/{botId}/replicas/{replicaRegion}/botversions Contains information about all the versions replication statuses applicable for Global Resiliency. #
DELETE /bots/{botId}/utterances Deletes stored utterances. #
POST /builtins/locales/{localeId}/intents Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. #
POST /builtins/locales/{localeId}/slottypes Gets a list of built-in slot types that meet the specified criteria. #
POST /createuploadurl Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale. #
PUT /exports Creates a zip archive containing the contents of a bot or a bot locale. #
POST /exports Lists the exports for a bot, bot locale, or custom vocabulary. #
DELETE /exports/{exportId} Removes a previous export and the associated files stored in an S3 bucket. #
GET /exports/{exportId} Gets information about a specific export. #
PUT /exports/{exportId} Updates the password used to protect an export zip archive. #
POST /imports Lists the imports for a bot, bot locale, or custom vocabulary. #
PUT /imports Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket. #
DELETE /imports/{importId} Removes a previous import and the associated file stored in an S3 bucket. #
GET /imports/{importId} Gets information about a specific import. #
POST /policy/{resourceArn} Creates a new resource policy with the specified policy statements. #
DELETE /policy/{resourceArn} Removes an existing policy from a bot or bot alias. #
GET /policy/{resourceArn} Gets the resource policy and policy revision for a bot or bot alias. #
PUT /policy/{resourceArn} Replaces the existing resource policy for a bot or bot alias with a new one. #
POST /policy/{resourceArn}/statements Adds a new resource policy statement to a bot or bot alias. #
DELETE /policy/{resourceArn}/statements/{statementId} Deletes a policy statement from a resource policy. #
GET /tags/{resourceARN} Gets a list of tags associated with a resource. #
POST /tags/{resourceARN} Adds the specified tags to the specified resource. #
DELETE /tags/{resourceARN} Removes tags from a bot, bot alias, or bot channel. #
POST /testexecutions The list of test set executions. #
GET /testexecutions/{testExecutionId} Gets metadata information about the test execution. #
GET /testexecutions/{testExecutionId}/artifacturl The pre-signed Amazon S3 URL to download the test execution result artifacts. #
POST /testexecutions/{testExecutionId}/results Gets a list of test execution result items. #
GET /testsetdiscrepancy/{testSetDiscrepancyReportId} Gets metadata information about the test set discrepancy report. #
PUT /testsetgenerations The action to start the generation of test set. #
GET /testsetgenerations/{testSetGenerationId} Gets metadata information about the test set generation. #
POST /testsets The list of the test sets #
DELETE /testsets/{testSetId} The action to delete the selected test set. #
GET /testsets/{testSetId} Gets metadata information about the test set. #
PUT /testsets/{testSetId} The action to update the test set. #
POST /testsets/{testSetId}/records The list of test set records. #
POST /testsets/{testSetId}/testexecutions The action to start test set execution. #
POST /testsets/{testSetId}/testsetdiscrepancy Create a report that describes the differences between the bot and the test set. #

Documentation

📖
Documentation
https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html
📖
GettingStarted
https://aws.amazon.com/lex/getting-started/
📖
APIReference
https://docs.aws.amazon.com/lexv2/latest/APIReference/Welcome.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/openapi/amazon-lex-models-v2-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/json-schema/json-schema.yml
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/json-schema/amazon-lex-bot-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/json-schema/amazon-lex-intent-schema.json

Other Resources

🔗
Smithy
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/smithy/amazon-lex-models-v2-2020-08-07.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/json-ld/json-ld.yml
🔗
Pricing
https://aws.amazon.com/lex/pricing/
🔗
FAQ
https://aws.amazon.com/lex/faqs/
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/overlays/amazon-lex-models-v2-overlay.yaml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/data-model/amazon-lex-data-model.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/json-ld/amazon-lex-context.jsonld
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/apis.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-lex-bots-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-lex-models-v2-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon Lex Model Building V2 API
  description: Amazon Lex V2 Model Building operations let you build and manage conversational bots —
    bots, aliases, locales, intents, slots, slot types, custom vocabularies, imports/exports, test sets
    and analytics. Derived mechanically from the AWS-published Smithy 2.0 service model (aws/api-models-aws,
    models/lex-models-v2/service/2020-08-07). Requests are signed with AWS Signature Version 4 using service
    name lex.
  version: '2020-08-07'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-generated-from: AWS Smithy 2.0 service model (https://github.com/aws/api-models-aws) — mechanical
    transform, no hand-authored operations
servers:
- url: https://models-v2-lex.us-east-1.amazonaws.com
  description: Amazon Lex V2 Model Building endpoint (us-east-1; one regional endpoint per AWS Region
    — see https://docs.aws.amazon.com/general/latest/gr/lex.html)
tags:
- name: bots
- name: builtins
- name: createuploadurl
- name: exports
- name: imports
- name: policy
- name: tags
- name: testexecutions
- name: testsetdiscrepancy
- name: testsetgenerations
- name: testsets
security:


# --- truncated at 32 KB (649 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/openapi/amazon-lex-models-v2-openapi.yml