Amazon Lex Runtime V2
This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.
AI & machine learning#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.
Endpoints 6
- GETGet session
/bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionIdReturns session information for a specified bot, alias, and user. For example, you can use this operation to retrieve session information for a user that has… - POSTPut session
/bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionIdCreates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot. - DELETEDelete session
/bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionIdRemoves session information for a specified bot, alias, and user ID. You can use this operation to restart a conversation with a bot. When you remove a… - POSTRecognize text
/bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionId/textSends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input… - POSTRecognize utterance
/bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionId/utteranceSends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex… - POSTStart conversation
/bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionId/conversationStarts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation,…
API details
- Base URL
https://runtime-v2-lex.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 6 operations on 4 pathsPOST 4GET 1DELETE 1
- Description format
- AWS Smithy model, API version
2020-08-07 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Lex Runtime V2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lex Runtime V2 collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get session” (GET /bots/:botId/botAliases/:botAliasId/botLocales/:localeId/sessions/:sessionId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Lex Runtime V2?
This section contains documentation for the Amazon Lex V2 Runtime V2 API operations. It is listed under AI & machine learning and has 6 endpoints.
Who publishes the Amazon Lex Runtime V2?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Lex Runtime V2?
Requests go to https://runtime-v2-lex.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Lex Runtime V2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Lex Runtime V2 have?
6 operations on 4 paths (4 POST, 1 GET, 1 DELETE).
Is forking the Amazon Lex Runtime V2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.