---
title: "POST /bots/"
method: POST
path: "/bots/"
---

# POST /bots/

`POST /bots/`

Gets a list of available bots.

## Request body

- object
  - `sortBy` object — Specifies attributes for sorting a list of bots.
    - `attribute` 'BotName' — The attribute to use to sort the list of bots.
    - `order` 'Ascending' | 'Descending' — The order to sort the list. You can choose ascending or descending.
  - `filters` BotFilter[] — Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
    - `name` 'BotName' | 'BotType', required — The name of the field to filter the list of bots.
    - `values` FilterValue[], required — The value to use for filtering the list of bots.
    - `operator` 'CO' | 'EQ' | 'NE', required — The operator to use for the filter. Specify <code>EQ</code> when the <code>ListBots</code> operation should return only aliases that equal the specified value. Specify <code>CO</code> when the <code>ListBots</code> operation should return aliases that contain the specified value.
  - `maxResults` integer — The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
  - `nextToken` string — <p>If the response from the <code>ListBots</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. </p> <p>Use the returned token in the <code>nextToken</code> parameter of a <code>ListBots</code> request to return the next page of results. For a complete set of results, call the <code>ListBots</code> operation until the <code>nextToken</code> returned in the response is null.</p>

## Response `200`

Success

- ListBotsResponse
  - `botSummaries` BotSummary[] — Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more bots available, the <code>nextToken</code> field contains a token to the next page of results.
    - `botId` string — The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html">DescribeBot</a> operation.
    - `botName` string — The name of the bot.
    - `description` string — The description of the bot.
    - `botStatus` 'Creating' | 'Available' | 'Inactive' | 'Deleting' | 'Failed' | 'Versioning' | 'Importing' | 'Updating' — The current status of the bot. When the status is <code>Available</code> the bot is ready for use.
    - `latestBotVersion` string — The latest numerical version in use for the bot.
    - `lastUpdatedDateTime` string, date-time — The date and time that the bot was last updated.
    - `botType` 'Bot' | 'BotNetwork' — The type of the bot.
  - `nextToken` string — A token that indicates whether there are more results to return in a response to the <code>ListBots</code> operation. If the <code>nextToken</code> field is present, you send the contents as the <code>nextToken</code> parameter of a <code>ListBots</code> operation request to get the next page of results.

## Other responses

- `480` — ThrottlingException
- `481` — ServiceQuotaExceededException
- `482` — ValidationException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/lexv2-models.md) · [All operations](https://skmtc.net/aws/apis/lexv2-models/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/lexv2-models/versions/6997ba482d72/schema)