Amazon Web Services, Inc.

Amazon Lex Runtime Service

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to…

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

Amazon Lex provides both build and runtime endpoints. Each endpoint
provides a set of operations (API). Your conversational bot uses the
runtime API to understand user utterances (user input text or voice). For
example, suppose a user says "I want pizza", your bot sends this input to
Amazon Lex using the runtime API. Amazon Lex recognizes that the user
request is for the OrderPizza intent (one of the intents defined in the
bot). Then Amazon Lex engages in user conversation on behalf of the bot to
elicit required information (slot values, such as pizza size and crust
type), and then performs fulfillment activity (that you configured when
you created the bot). You use the build-time API to create and manage your
Amazon Lex bot. For a list of build-time operations, see the build-time
API, .

Endpoints 5

  • GETGet session/bot/:botName/alias/:botAlias/user/:userId/session?checkpointLabelFilter=stringReturns session information for a specified bot, alias, and user ID.
  • POSTPut session/bot/:botName/alias/:botAlias/user/:userId/sessionCreates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot. For…
  • DELETEDelete session/bot/:botName/alias/:botAlias/user/:userId/sessionRemoves session information for a specified bot, alias, and user ID.
  • POSTPost content/bot/:botName/alias/:botAlias/user/:userId/contentSends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user…
  • POSTPost text/bot/:botName/alias/:botAlias/user/:userId/textSends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input…

API details

Base URL
https://runtime.lex.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
5 operations on 3 pathsPOST 3GET 1DELETE 1
Description format
AWS Smithy model, API version 2016-11-28

How to test the Amazon Lex Runtime Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lex Runtime Service collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Get session” (GET /bot/:botName/alias/:botAlias/user/:userId/session?checkpointLabelFilter=string), 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 Service?

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to… It is listed under AI & machine learning and has 5 endpoints.

Who publishes the Amazon Lex Runtime Service?

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 Service?

Requests go to https://runtime.lex.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Lex Runtime Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Lex Runtime Service have?

5 operations on 3 paths (3 POST, 1 GET, 1 DELETE).

Is forking the Amazon Lex Runtime Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.