Amazon Lex

Amazon Lex Bots API

Lex bot management

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 80

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

PUT /bots Create a bot with name, role and privacy settings · Creates an Amazon Lex conversational bot #
Ask an LLM
“How do I create a new Lex bot with an IAM role and an idle session timeout?”
“What do I have to set for data privacy when I create a bot?”
Tell an agent
Create a bot named {botName} using IAM role {roleArn} with a {idleSessionTTLInSeconds}-second idle session timeout and privacy setting {dataPrivacy}.
Create a bot network called {botName} with member bots {botMembers}, using role {roleArn}, privacy {dataPrivacy} and a {idleSessionTTLInSeconds}s timeout.
POST /bots Create a bot via the POST /bots endpoint · Gets a list of available bots #
Ask an LLM
“Is there a POST /bots variant for creating a Lex bot with no request fields?”
“What does the bare POST create-bot call on /bots do?”
Tell an agent
Call the POST /bots create-bot endpoint to make a new bot.
Use the parameterless POST variant of create bot.
GET /bots List my conversational bots · Amazon Lex List Bots #
Ask an LLM
“Which Lex bots do I have in this account?”
“Can I see every conversational bot I've built in Amazon Lex?”
Tell an agent
List all of my Lex bots.
Show me every conversational bot available in this account.
DELETE /bots/{botId} Delete a bot and all its versions · Deletes all versions of a bot, including the Draft version #
Ask an LLM
“How do I delete a Lex bot entirely, including its Draft version?”
“Does deleting a bot remove every version of it?”
Tell an agent destructive · confirm first
Delete bot {botId} and all of its versions.
Permanently remove the whole bot {botId}, Draft included.
GET /bots/{botId} Get a bot's details · Provides metadata information about a bot #
Ask an LLM
“What's the configuration and status of one of my bots?”
“Can I look up the role and idle timeout set on a particular bot?”
Tell an agent
Describe bot {botId}.
Show me the metadata for bot {botId}.
PUT /bots/{botId} Update a bot's configuration · Updates the configuration of an existing bot #
Ask an LLM
“How do I change the configuration of a bot that already exists?”
“Can I edit an existing bot's settings after creating it?”
Tell an agent
Update the configuration of bot {botId}.
Apply new settings to my existing bot {botId}.
POST /bots/{botId}/aggregatedutterances See what users actually said to a bot · Provides a list of utterances that users have sent to the bot #
Ask an LLM
“What phrases are customers typing or saying to my bot, grouped by text?”
“Can I see how often users said the same utterance over the last day or week?”
Tell an agent
List aggregated user utterances for bot {botId} in locale {localeId} over {aggregationDuration}.
Show what users said to alias {botAliasId} of bot {botId} in {localeId} during {aggregationDuration}.
POST /bots/{botId}/analytics/intentmetrics Get summary metrics for a bot's intents · Retrieves summary metrics for the intents in your bot #
Ask an LLM
“How many times was each intent in my bot matched or failed last month?”
“Can I get intent success and failure counts binned by day?”
Tell an agent
Get intent metrics {metrics} for bot {botId} from {startDateTime} to {endDateTime}.
Report intent metrics {metrics} for bot {botId} between {startDateTime} and {endDateTime}, grouped by {groupBy}.
POST /bots/{botId}/analytics/intentpaths Analyze the paths of intents users take · Retrieves summary statistics for a path of intents that users take over… #
Ask an LLM
“What sequence of intents do users go through in sessions with my bot?”
“Which intents do people hit after a given intent path in a conversation?”
Tell an agent
Show intent path statistics for {intentPath} on bot {botId} from {startDateTime} to {endDateTime}.
Trace where sessions go after intent path {intentPath} in bot {botId}, {startDateTime} through {endDateTime}.
POST /bots/{botId}/analytics/intentstagemetrics Get metrics for stages within intents · Retrieves summary metrics for the stages within intents in your bot #
Ask an LLM
“Where inside an intent do conversations stall, stage by stage?”
“Can I see metrics for each stage of my bot's intents, like slot elicitation?”
Tell an agent
Pull per-stage metrics {metrics} inside the intents of bot {botId}, {startDateTime} through {endDateTime}.
Break down stage-level metrics {metrics} for bot {botId} between {startDateTime} and {endDateTime} by {binBy}.
POST /bots/{botId}/analytics/sessionmetrics Get summary metrics for bot user sessions · Retrieves summary metrics for the user sessions with your bot #
Ask an LLM
“How many user sessions did my bot have, and how long did they last?”
“Can I get session count and duration metrics summarized over a date range?”
Tell an agent
Get session metrics {metrics} for bot {botId} from {startDateTime} to {endDateTime}.
Summarize session totals for bot {botId} between {startDateTime} and {endDateTime}.
POST /bots/{botId}/analytics/sessions List metadata for individual bot sessions · Retrieves a list of metadata for individual user sessions with your bot #
Ask an LLM
“Can I pull a list of individual conversations users had with my bot?”
“Which specific sessions happened on my bot during a given time window?”
Tell an agent
List individual session records for bot {botId} from {startDateTime} to {endDateTime}.
Show each user session on bot {botId} between {startDateTime} and {endDateTime}, sorted by {sortBy}.
POST /bots/{botId}/analytics/utterancemetrics Get summary metrics for bot utterances · To use this API operation, your IAM role must have permissions to perform the… #
Ask an LLM
“How many utterances did my bot detect versus miss over a period?”
“What IAM permission do I need to read utterance metrics for my bot?”
Tell an agent
Get utterance metrics {metrics} for bot {botId} from {startDateTime} to {endDateTime}.
Summarize utterance counts for bot {botId} between {startDateTime} and {endDateTime} with attributes {attributes}.
POST /bots/{botId}/analytics/utterances List individual utterance records for a bot · To use this API operation, your IAM role must have permissions to perform the… #
Ask an LLM
“Can I get the individual utterances users sent my bot, one record each?”
“Where do I find per-utterance analytics data for a date range?”
Tell an agent
List individual utterance records for bot {botId} from {startDateTime} to {endDateTime}.
Pull each utterance record from bot {botId} between {startDateTime} and {endDateTime}, filtered by {filters}.
PUT /bots/{botId}/botaliases Create an alias pointing to a bot version · Creates an alias for the specified version of a bot #
Ask an LLM
“How do I create a production alias so apps don't need to change when I ship a new bot version?”
“Can a new alias turn on conversation logs and sentiment analysis?”
Tell an agent
Create alias {botAliasName} on bot {botId} pointing to version {botVersion}.
Add a new alias named {botAliasName} to bot {botId}.
POST /bots/{botId}/botaliases List a bot's aliases · Gets a list of aliases for the specified bot #
Ask an LLM
“What aliases exist for my bot?”
“Which aliases have I set up on a particular bot?”
Tell an agent
List the aliases for bot {botId}.
Show up to {maxResults} aliases of bot {botId}.
DELETE /bots/{botId}/botaliases/{botAliasId} Delete a bot alias · Deletes the specified bot alias #
Ask an LLM
“How do I remove an alias from my bot?”
“Can I delete an alias even if it's still in use by something?”
Tell an agent destructive · confirm first
Delete alias {botAliasId} from bot {botId}.
Delete alias {botAliasId} of bot {botId}, skipping the in-use check ({skipResourceInUseCheck}).
GET /bots/{botId}/botaliases/{botAliasId} Get details of a bot alias · Get information about a specific bot alias #
Ask an LLM
“Which bot version is a specific alias currently pointing to?”
“Can I check the log and sentiment settings on one alias?”
Tell an agent
Describe alias {botAliasId} of bot {botId}.
Show the configuration of bot alias {botAliasId} on bot {botId}.
PUT /bots/{botId}/botaliases/{botAliasId} Repoint or reconfigure a bot alias · Updates the configuration of an existing bot alias #
Ask an LLM
“How do I switch an existing alias to a newer bot version?”
“Can I change conversation log settings on an alias I already have?”
Tell an agent
Point alias {botAliasId} ({botAliasName}) of bot {botId} at version {botVersion}.
Rename alias {botAliasId} on bot {botId} to {botAliasName}.
POST /bots/{botId}/botanalyzer Run an AI analysis of a bot's configuration · Initiates an asynchronous analysis of your bot configuration using AI-powered… #
Ask an LLM
“Can Lex analyze my bot's design and recommend improvements based on best practices?”
“How do I kick off an automated review of my bot to find configuration issues?”
Tell an agent
Start a bot analyzer run on bot {botId} with scope {analysisScope}.
Analyze bot {botId} version {botVersion} in locale {localeId} with scope {analysisScope} for improvement recommendations.
POST /bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId} Get a bot analysis's recommendations · Retrieves the analysis results and recommendations for bot optimization #
Ask an LLM
“What did the bot analyzer recommend I fix once the analysis finished?”
“Can I page through the recommendations from a completed bot analysis?”
Tell an agent
Show the recommendations from bot analysis {botAnalyzerRequestId} on bot {botId}.
Get the analyzer results for request {botAnalyzerRequestId} of bot {botId}.
POST /bots/{botId}/botanalyzer/history List past bot analysis runs · Retrieves a list of historical bot analysis executions for a specific bot #
Ask an LLM
“Which analyzer runs have been executed against my bot before?”
“Can I filter a bot's analysis history by locale and version?”
Tell an agent
List the analysis history for bot {botId}.
Show past analyzer runs on bot {botId} for version {botVersion} in locale {localeId}.
DELETE /bots/{botId}/botanalyzer/{botAnalyzerRequestId} Permanently delete a bot analysis's results · Permanently deletes the recommendations and analysis results for a specific bot… #
Ask an LLM
“How do I permanently erase analyzer recommendations for GDPR purposes?”
“Can deleted bot analysis results be recovered afterwards?”
Tell an agent destructive · confirm first
Delete the analysis results for request {botAnalyzerRequestId} on bot {botId}.
Permanently erase the analyzer recommendations {botAnalyzerRequestId} from bot {botId}.
PUT /bots/{botId}/botanalyzer/{botAnalyzerRequestId}/stop Cancel a running bot analysis · Cancels an ongoing bot analysis execution #
Ask an LLM
“How do I stop a bot analysis that's still in progress?”
“Can a cancelled bot analysis be resumed later?”
Tell an agent destructive · confirm first
Stop bot analysis {botAnalyzerRequestId} on bot {botId}.
Cancel the running analyzer job {botAnalyzerRequestId} for bot {botId}.
PUT /bots/{botId}/botversions Publish an immutable bot version · Creates an immutable version of the bot #
Ask an LLM
“How do I snapshot my Draft bot into a numbered, immutable version?”
“Are deleted bot version numbers ever reused?”
Tell an agent
Create a new version of bot {botId} from locales {botVersionLocaleSpecification}.
Publish a numbered version of bot {botId} described as {description} using {botVersionLocaleSpecification}.
POST /bots/{botId}/botversions List a bot's versions · Gets information about all of the versions of a bot #
Ask an LLM
“What numbered versions of my bot exist?”
“Can I sort the list of a bot's versions?”
Tell an agent
List all versions of bot {botId}.
Show the versions of bot {botId} sorted by {sortBy}.
DELETE /bots/{botId}/botversions/{botVersion} Delete one version of a bot · Deletes a specific version of a bot #
Ask an LLM
“How do I delete just one old version of a bot without removing the bot?”
“Can I force-delete a bot version that an alias still uses?”
Tell an agent destructive · confirm first
Delete version {botVersion} of bot {botId}.
Remove bot {botId} version {botVersion} with skipResourceInUseCheck set to {skipResourceInUseCheck}.
GET /bots/{botId}/botversions/{botVersion} Get details of one bot version · Provides metadata about a version of a bot #
Ask an LLM
“What's the status and metadata of a specific version of my bot?”
“Can I inspect one numbered bot version on its own?”
Tell an agent
Describe version {botVersion} of bot {botId}.
Show metadata for bot {botId} at version {botVersion}.
PUT /bots/{botId}/botversions/{botVersion}/botlocales Add a language locale to a bot · Creates a locale in the bot #
Ask an LLM
“How do I add Spanish or another language to my bot?”
“What confidence threshold must I set when adding a locale?”
Tell an agent
Add locale {localeId} to bot {botId} version {botVersion} with an intent confidence threshold of {nluIntentConfidenceThreshold}.
Create locale {localeId} on bot {botId} version {botVersion} with threshold {nluIntentConfidenceThreshold} and voice {voiceSettings}.
POST /bots/{botId}/botversions/{botVersion}/botlocales List the locales in a bot version · Gets a list of locales for the specified bot #
Ask an LLM
“Which languages does my bot support?”
“Can I list the locales configured on a given bot version?”
Tell an agent
List the locales in bot {botId} version {botVersion}.
Show which languages bot {botId} version {botVersion} has, filtered by {filters}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Build a bot for a locale · Builds a bot, its intents, and its slot types into a specific locale #
Ask an LLM
“How do I build my bot's intents and slot types so a locale is ready to test?”
“Do I need to rebuild a locale after changing its intents?”
Tell an agent
Build locale {localeId} of bot {botId} version {botVersion}.
Compile bot {botId} version {botVersion} into the {localeId} locale.
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Remove a locale from a bot · Removes a locale from a bot #
Ask an LLM
“How do I remove a language from my bot?”
“Does deleting a locale also delete its intents and slot types?”
Tell an agent destructive · confirm first
Delete locale {localeId} from bot {botId} version {botVersion}.
Remove the {localeId} language and everything in it from bot {botId}, version {botVersion}.
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Get a bot locale's settings · Describes the settings that a bot has for a specific locale #
Ask an LLM
“What confidence threshold and voice are configured for one of my bot's locales?”
“Has a particular bot locale been built yet?”
Tell an agent
Describe locale {localeId} of bot {botId} version {botVersion}.
Show the build status and settings for {localeId} on bot {botId}, version {botVersion}.
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId} Change a bot locale's settings · Updates the settings that a bot has for a specific locale #
Ask an LLM
“How do I raise the intent confidence threshold on an existing locale?”
“Can I change the voice or speech detection sensitivity for a locale I already added?”
Tell an agent
Set the confidence threshold for locale {localeId} of bot {botId} version {botVersion} to {nluIntentConfidenceThreshold}.
Update locale {localeId} on bot {botId} version {botVersion}: threshold {nluIntentConfidenceThreshold}, speech sensitivity {speechDetectionSensitivity}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations List transcript-based bot recommendations · Get a list of bot recommendations that meet the specified criteria #
Ask an LLM
“Which bot recommendation requests have I run for a locale?”
“Can I see all transcript analysis jobs for my bot's locale?”
Tell an agent
List bot recommendations for bot {botId} version {botVersion}, locale {localeId}.
Show the transcript recommendation jobs on the {localeId} locale of bot {botId} version {botVersion}.
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations Start intent recommendations from transcripts · Use this to provide your transcript data, and to start the bot recommendation… #
Ask an LLM
“Can Lex suggest intents for my bot from existing call or chat transcripts?”
“How do I feed conversation transcripts in to get bot design recommendations?”
Tell an agent
Start a bot recommendation for bot {botId} version {botVersion}, locale {localeId}, using transcripts from {transcriptSourceSetting}.
Analyze transcripts at {transcriptSourceSetting} for locale {localeId} of bot {botId} version {botVersion}, encrypted with {encryptionSetting}.
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId} Get status of a bot recommendation job · Provides metadata information about a bot recommendation #
Ask an LLM
“Is my transcript-based bot recommendation finished processing?”
“Where can I download the transcripts associated with a recommendation?”
Tell an agent
Describe bot recommendation {botRecommendationId} for bot {botId} version {botVersion}, locale {localeId}.
Check the status of recommendation job {botRecommendationId} on bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId} Change encryption on a bot recommendation · Updates an existing bot recommendation request #
Ask an LLM
“Can I change the encryption settings of a bot recommendation request I already started?”
“How do I update the KMS encryption on an existing recommendation job?”
Tell an agent
Update the encryption of recommendation {botRecommendationId} on bot {botId} version {botVersion}, locale {localeId}, to {encryptionSetting}.
Set encryption {encryptionSetting} on existing bot recommendation {botRecommendationId} for bot {botId} ({botVersion}, {localeId}).
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts Search transcripts tied to a bot recommendation · Search for associated transcripts that meet the specified criteria #
Ask an LLM
“Can I search the transcripts that were used for a bot recommendation?”
“Which transcripts associated with a recommendation match my filter?”
Tell an agent
Search transcripts for recommendation {botRecommendationId} on bot {botId} version {botVersion}, locale {localeId}, with filters {filters}.
Find associated transcripts matching {filters} in recommendation {botRecommendationId} of bot {botId} ({botVersion}, {localeId}), ordered {searchOrder}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents List intents recommended from transcripts · Gets a list of recommended intents provided by the bot recommendation that you… #
Ask an LLM
“What intents did the transcript analysis suggest I add to my bot?”
“Are recommended intents ranked by relevance?”
Tell an agent
List recommended intents from recommendation {botRecommendationId} for bot {botId} version {botVersion}, locale {localeId}.
Show the suggested intents produced by job {botRecommendationId} on bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation Stop a running bot recommendation job · Stop an already running Bot Recommendation request #
Ask an LLM
“How do I halt a transcript recommendation job that's still running?”
“Can I cancel an in-progress bot recommendation request?”
Tell an agent destructive · confirm first
Stop bot recommendation {botRecommendationId} on bot {botId} version {botVersion}, locale {localeId}.
Cancel the running recommendation job {botRecommendationId} for bot {botId} ({botVersion}, {localeId}).
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary Remove a locale's custom vocabulary · Removes a custom vocabulary from the specified locale in the specified bot #
Ask an LLM
“How do I delete the entire custom vocabulary from a bot locale?”
“Can I drop all custom vocabulary for one language of my bot at once?”
Tell an agent destructive · confirm first
Delete the custom vocabulary from locale {localeId} of bot {botId} version {botVersion}.
Remove the whole custom vocabulary on bot {botId} ({botVersion}) for {localeId}.
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchcreate Add custom vocabulary items in bulk · Create a batch of custom vocabulary items for a given bot locale's custom… #
Ask an LLM
“How do I teach my bot product names and jargon it keeps mishearing?”
“Can I add many custom vocabulary phrases to a locale in one call?”
Tell an agent
Add vocabulary items {customVocabularyItemList} to locale {localeId} of bot {botId} version {botVersion}.
Create these custom vocabulary entries for bot {botId} ({botVersion}, {localeId}): {customVocabularyItemList}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchdelete Delete custom vocabulary items in bulk · Delete a batch of custom vocabulary items for a given bot locale's custom… #
Ask an LLM
“Can I remove several specific words from my bot's custom vocabulary at once?”
“How do I delete selected custom vocabulary items without dropping the whole vocabulary?”
Tell an agent destructive · confirm first
Delete vocabulary items {customVocabularyItemList} from locale {localeId} of bot {botId} version {botVersion}.
Remove these custom vocabulary entries from bot {botId} ({botVersion}, {localeId}): {customVocabularyItemList}.
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate Update custom vocabulary items in bulk · Update a batch of custom vocabulary items for a given bot locale's custom… #
Ask an LLM
“How do I change the weight or display form of existing custom vocabulary items?”
“Can I edit several vocabulary entries already in a locale in one request?”
Tell an agent
Update vocabulary items {customVocabularyItemList} in locale {localeId} of bot {botId} version {botVersion}.
Modify these existing custom vocabulary entries on bot {botId} ({botVersion}, {localeId}): {customVocabularyItemList}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/list List a locale's custom vocabulary items · Paginated list of custom vocabulary items for a given bot locale's custom… #
Ask an LLM
“What words are in my bot locale's custom vocabulary right now?”
“Can I page through all the custom vocabulary items for a language?”
Tell an agent
List custom vocabulary items for locale {localeId} of bot {botId} version {botVersion}.
Show the first {maxResults} vocabulary entries on bot {botId} ({botVersion}, {localeId}).
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/metadata Get custom vocabulary metadata · Provides metadata information about a custom vocabulary #
Ask an LLM
“What's the status of the custom vocabulary on my bot locale?”
“When was a locale's custom vocabulary created or last updated?”
Tell an agent
Describe the custom vocabulary metadata for locale {localeId} of bot {botId} version {botVersion}.
Show the vocabulary status for bot {botId} ({botVersion}) in {localeId}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generate Generate sample utterances for an intent · Generates sample utterances for an intent #
Ask an LLM
“Can Lex write sample utterances for one of my intents automatically?”
“How do I get generated example phrases for an intent I already created?”
Tell an agent
Generate sample utterances for intent {intentId} in bot {botId} version {botVersion}, locale {localeId}.
Suggest example phrases for intent {intentId} on bot {botId} ({botVersion}, {localeId}).
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generations List descriptive bot builder generation requests · Lists the generation requests made for a bot locale #
Ask an LLM
“Which generate-from-description requests have been made for my bot locale?”
“Can I sort the descriptive bot builder generation history?”
Tell an agent
List generation requests for bot {botId} version {botVersion}, locale {localeId}.
Show the descriptive bot builder runs on {localeId} of bot {botId} ({botVersion}) sorted by {sortBy}.
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/generations/{generationId} Get a descriptive bot builder generation result · Returns information about a request to generate a bot through natural language… #
Ask an LLM
“Is the bot my natural-language description generated ready yet?”
“Where do I get the S3 link to the generated bot locale configuration?”
Tell an agent
Describe generation {generationId} for bot {botId} version {botVersion}, locale {localeId}.
Get the status and output location of bot generation {generationId} on bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents Create an intent with utterances and hooks · Creates an intent #
Ask an LLM
“How do I add a new intent like OrderPizza with sample utterances to my bot?”
“Can I base a new intent on a built-in intent signature?”
Tell an agent
Create intent {intentName} in bot {botId} version {botVersion}, locale {localeId}.
Add intent {intentName} with sample utterances {sampleUtterances} to the {localeId} locale of bot {botId} version {botVersion}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents Create an intent via the POST endpoint · Get a list of intents that meet the specified criteria #
Ask an LLM
“Is there a POST variant of create intent that takes no intent fields in the body?”
“What does the bare POST create-intent call on a bot locale do?”
Tell an agent
Use the POST create-intent endpoint on bot {botId} version {botVersion}, locale {localeId}.
Call the parameterless POST intent-creation variant for locale {localeId} of bot {botId} version {botVersion}.
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents List intents in a bot locale · Amazon Lex List Intents #
Ask an LLM
“Which intents are defined in my bot for a given language?”
“Can I get all the intents in one locale of a bot version?”
Tell an agent
List the intents in bot {botId} version {botVersion} for locale {localeId}.
Show every intent in the {localeId} locale of bot {botId}, version {botVersion}.
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId} Delete an intent · Removes the specified intent #
Ask an LLM
“How do I remove an intent from my bot?”
“Does deleting an intent also delete its slots?”
Tell an agent destructive · confirm first
Delete intent {intentId} from bot {botId} version {botVersion}, locale {localeId}.
Remove intent {intentId} and its slots on bot {botId} ({botVersion}, {localeId}).
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId} Get an intent's details · Returns metadata about an intent #
Ask an LLM
“What sample utterances and hooks does a particular intent have?”
“Can I look at one intent's full configuration?”
Tell an agent
Describe intent {intentId} in bot {botId} version {botVersion}, locale {localeId}.
Show the settings of intent {intentId} on bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId} Update an existing intent · Updates the settings for an intent #
Ask an LLM
“How do I add more sample utterances to an intent I already built?”
“Can I change the order slots are prompted in for an existing intent?”
Tell an agent
Update intent {intentId} ({intentName}) in bot {botId} version {botVersion}, locale {localeId}, with utterances {sampleUtterances}.
Set slot priorities {slotPriorities} on existing intent {intentId} named {intentName} of bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots Add a slot to an intent · Creates a slot in an intent #
Ask an LLM
“How do I make my intent collect a value like pizza size or crust?”
“Can a new slot accept multiple values or be obfuscated in logs?”
Tell an agent
Create slot {slotName} of type {slotTypeId} on intent {intentId}, bot {botId} ({botVersion}, {localeId}), prompting via {valueElicitationSetting}.
Add slot {slotName} to intent {intentId} of bot {botId} ({botVersion}, {localeId}) using prompt settings {valueElicitationSetting}.
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots List the slots in an intent · Gets a list of slots that match the specified criteria #
Ask an LLM
“Which slots does one of my intents collect?”
“Can I filter or sort the slots belonging to an intent?”
Tell an agent
List the slots in intent {intentId} of bot {botId} version {botVersion}, locale {localeId}.
Show slots on intent {intentId} for bot {botId} ({botVersion}, {localeId}) sorted by {sortBy}.
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId} Delete a slot from an intent · Deletes the specified slot from an intent #
Ask an LLM
“How do I remove a slot my intent no longer needs?”
“Can I delete a single slot without touching the rest of the intent?”
Tell an agent destructive · confirm first
Delete slot {slotId} from intent {intentId} in bot {botId} version {botVersion}, locale {localeId}.
Remove slot {slotId} on intent {intentId} of bot {botId} ({botVersion}, {localeId}).
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId} Get a slot's details · Gets metadata information about a slot #
Ask an LLM
“What prompts and slot type does a particular slot use?”
“Can I inspect the configuration of one slot in an intent?”
Tell an agent
Describe slot {slotId} in intent {intentId} of bot {botId} version {botVersion}, locale {localeId}.
Show how slot {slotId} is prompted and typed within intent {intentId}, bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId} Update an existing slot · Updates the settings for a slot #
Ask an LLM
“How do I change the prompt or slot type of an existing slot?”
“Can I turn on obfuscation for a slot that's already defined?”
Tell an agent
Update slot {slotId} ({slotName}) on intent {intentId} of bot {botId} version {botVersion}, locale {localeId}, with elicitation {valueElicitationSetting}.
Obfuscate slot {slotId} ({slotName}) with {obfuscationSetting}, intent {intentId}, bot {botId} ({botVersion}, {localeId}), prompts {valueElicitationSetting}.
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes Create a custom slot type · Creates a custom slot type To create a custom slot type, specify a name for the… #
Ask an LLM
“How do I define a custom list of allowed values, like crust types, for a slot?”
“Can a custom slot type extend a built-in type or pull values from an external grammar?”
Tell an agent
Create slot type {slotTypeName} with values {slotTypeValues} in bot {botId} version {botVersion}, locale {localeId}.
Add a custom slot type {slotTypeName} based on {parentSlotTypeSignature} to bot {botId} ({botVersion}, {localeId}).
POST /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes List a bot locale's slot types · Gets a list of slot types that match the specified criteria #
Ask an LLM
“What custom slot types have I defined for a bot locale?”
“Can I filter the slot types in my bot by name?”
Tell an agent
List slot types in bot {botId} version {botVersion}, locale {localeId}.
Show slot types on bot {botId} ({botVersion}, {localeId}) matching {filters}.
DELETE /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId} Delete a slot type · Deletes a slot type from a bot locale #
Ask an LLM
“How do I delete a custom slot type from a bot locale?”
“What happens if I try to delete a slot type that slots still use?”
Tell an agent destructive · confirm first
Delete slot type {slotTypeId} from bot {botId} version {botVersion}, locale {localeId}.
Force-delete slot type {slotTypeId} on bot {botId} ({botVersion}, {localeId}) with skipResourceInUseCheck {skipResourceInUseCheck}.
GET /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId} Get a slot type's details · Gets metadata information about a slot type #
Ask an LLM
“What values and resolution strategy does a custom slot type have?”
“Can I look up one slot type's configuration?”
Tell an agent
Describe slot type {slotTypeId} in bot {botId} version {botVersion}, locale {localeId}.
Show the values defined for slot type {slotTypeId} on bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId} Update a custom slot type · Updates the configuration of an existing slot type #
Ask an LLM
“How do I add new allowed values to a slot type I already created?”
“Can I change how an existing slot type resolves synonyms?”
Tell an agent
Update slot type {slotTypeId} ({slotTypeName}) in bot {botId} version {botVersion}, locale {localeId}, with values {slotTypeValues}.
Set value selection {valueSelectionSetting} on existing slot type {slotTypeId} named {slotTypeName}, bot {botId} ({botVersion}, {localeId}).
PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/startgeneration Generate a bot locale from a text description · Starts a request for the descriptive bot builder to generate a bot locale… #
Ask an LLM
“Can I describe my bot in plain English and have Lex generate the intents and slots?”
“How do I use the descriptive bot builder to draft a locale configuration?”
Tell an agent
Generate a bot configuration for locale {localeId} of bot {botId} version {botVersion} from the prompt {generationInputPrompt}.
Build intents and slots for bot {botId} ({botVersion}, {localeId}) from this description: {generationInputPrompt}.
PUT /bots/{botId}/replicas Replicate a bot to a secondary region · Action to create a replication of the source bot in the secondary region #
Ask an LLM
“How do I replicate my bot into another AWS region for resiliency?”
“Can I set up a copy of a bot in a secondary region?”
Tell an agent
Replicate bot {botId} to region {replicaRegion}.
Create a replica of bot {botId} in {replicaRegion} for Global Resiliency.
POST /bots/{botId}/replicas List a bot's regional replicas · The action to list the replicated bots #
Ask an LLM
“Which regions has my bot been replicated to?”
“Can I see all the replicas of a source bot?”
Tell an agent
List the replicas of bot {botId}.
Show every region where bot {botId} is replicated.
DELETE /bots/{botId}/replicas/{replicaRegion} Delete a bot's replica in a region · The action to delete the replicated bot in the secondary region #
Ask an LLM
“How do I stop replicating my bot to a secondary region and remove the copy?”
“Can I delete the replicated bot in one region only?”
Tell an agent destructive · confirm first
Delete the replica of bot {botId} in {replicaRegion}.
Remove bot {botId}'s replicated copy from region {replicaRegion}.
GET /bots/{botId}/replicas/{replicaRegion} Check a bot replica's status · Monitors the bot replication status through the UI console #
Ask an LLM
“Is my bot's replication to a secondary region complete?”
“What's the replication status of a bot in one particular region?”
Tell an agent
Describe the replica of bot {botId} in {replicaRegion}.
Check replication status for bot {botId} in region {replicaRegion}.
POST /bots/{botId}/replicas/{replicaRegion}/botaliases List replicated aliases in a region · The action to list the replicated bots created from the source bot alias #
Ask an LLM
“Which of my bot's aliases have been replicated to a secondary region?”
“Can I check alias replication status in the replica region?”
Tell an agent
List replicated aliases for bot {botId} in {replicaRegion}.
Show alias replicas of bot {botId} in region {replicaRegion}.
POST /bots/{botId}/replicas/{replicaRegion}/botversions List replicated bot versions in a region · Contains information about all the versions replication statuses applicable for… #
Ask an LLM
“Which versions of my bot have replicated to the secondary region?”
“What's the replication status of each bot version for Global Resiliency?”
Tell an agent
List replicated versions of bot {botId} in {replicaRegion}.
Show version replication statuses for bot {botId} in region {replicaRegion}, sorted by {sortBy}.
DELETE /bots/{botId}/utterances Delete stored user utterances · Deletes stored utterances #
Ask an LLM
“How do I delete the utterances Lex stored from a user's conversation?”
“Can I erase stored utterances for just one session or one locale?”
Tell an agent destructive · confirm first
Delete stored utterances for bot {botId}.
Erase the utterances stored from session {sessionId} in locale {localeId} of bot {botId}.
DELETE /bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId} Reset a user's conversation session · Removes session information for a specified bot, alias, and user ID #
Ask an LLM
“How do I restart a conversation with my bot by clearing the session?”
“Does removing a session wipe its whole history?”
Tell an agent destructive · confirm first
Delete session {sessionId} on bot {botId}, alias {botAliasId}, locale {localeId}.
Clear user session {sessionId} for bot {botId} ({botAliasId}, {localeId}) so the conversation starts over.
GET /bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId} Get a user's conversation session state · Returns session information for a specified bot, alias, and user #
Ask an LLM
“Can I see where a user left off in a long-running conversation with my bot?”
“What intent and slot values are in a user's current session?”
Tell an agent
Get session {sessionId} for bot {botId}, alias {botAliasId}, locale {localeId}.
Show the current state of user session {sessionId} on bot {botId} ({botAliasId}, {localeId}).
POST /bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId} Create or set a conversation session's state · Creates a new session or modifies an existing session with an Amazon Lex V2 bot #
Ask an LLM
“How do I set the dialog state of a user's session from my application?”
“Can my app start a session with the bot already in a particular intent?”
Tell an agent
Set session {sessionId} on bot {botId}, alias {botAliasId}, locale {localeId} to state {sessionState}.
Create session {sessionId} for bot {botId} ({botAliasId}, {localeId}) with state {sessionState} and messages {messages}.
POST /bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/conversation Stream a real-time audio or text conversation · Starts an HTTP/2 bidirectional event stream that enables you to send audio… #
Ask an LLM
“Can I stream live audio or DTMF keypresses to my bot over a bidirectional connection?”
“What audio format does a streaming conversation with the bot expect?”
Tell an agent
Start a streaming conversation for session {sessionId} with bot {botId}, alias {botAliasId}, locale {localeId}.
Open an HTTP/2 event stream to bot {botId} ({botAliasId}, {localeId}) for session {sessionId} in {conversationMode} mode.
POST /bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/text Send a text message to a bot · Sends user input to Amazon Lex V2 #
Ask an LLM
“How do I send a user's typed message to my bot and get its reply?”
“Can I pass session attributes along with a text message to the bot?”
Tell an agent
Send the text {text} to bot {botId}, alias {botAliasId}, locale {localeId}, in session {sessionId}.
Ask bot {botId} ({botAliasId}, {localeId}) "{text}" as session {sessionId} and return its interpretation.
POST /bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/utterance Send speech or text as a single utterance · Sends user input to Amazon Lex V2 #
Ask an LLM
“How do I send a recorded audio clip to my bot and get a spoken response back?”
“Which fields have to be gzipped and base64 encoded when sending an utterance?”
Tell an agent
Send an audio utterance of type {contentType} to bot {botId}, alias {botAliasId}, locale {localeId}, session {sessionId}.
Submit a {contentType} utterance to bot {botId} ({botAliasId}, {localeId}) for session {sessionId} and return audio as {responseContentType}.

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
📖
Documentation
https://docs.aws.amazon.com/lexv2/latest/dg/how-it-works.html
📖
APIReference
https://docs.aws.amazon.com/lexv2/latest/APIReference/API_Operations_Amazon_Lex_Runtime_V2.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/openapi/amazon-lex-bots-api-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/
🔗
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
🔗
Smithy
https://raw.githubusercontent.com/api-evangelist/amazon-lex/refs/heads/main/smithy/amazon-lex-runtime-v2-2020-08-07.json
🔗
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: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-bots-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Lex Bots API
  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-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged bots across 3 of this provider''s published API definitions: amazon-lex-models-v2-openapi.yml, amazon-lex-openapi.yml, amazon-lex-runtime-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
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)
- url: https://runtime-v2-lex.us-east-1.amazonaws.com
  description: Amazon Lex V2 Runtime endpoint (us-east-1; one regional endpoint per AWS Region — see https://docs.aws.amazon.com/general/latest/gr/lex.html)
security:
- sigv4: []
tags:


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