> ## Documentation Index
> Fetch the complete documentation index at: https://bazable.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# bazable explain

> Get a plain-English AI explanation of any API endpoint.

Uses AI to provide a plain‑English explanation of an endpoint.

## Usage

```bash theme={null}
bazable explain <method> <url>
```

## Options

<Info>
  This command takes no options.
</Info>

## Prerequisites

* An AI API key must be configured. Run `bazable config --set-ai-key <your-key>` (and optionally `--set-ai-base` and `--set-ai-model` if you use a provider other than OpenAI). See [`bazable config`](/commands/config).
* The endpoint must exist in your `bazable.config.json` with a request and/or response schema.

## What it does

Sends the endpoint's method, URL, request schema, and response schema to the configured AI model. The AI returns a concise, plain-English summary covering:

* What the endpoint does
* What data must be sent
* What data will be returned
* Any edge cases or common pitfalls

The explanation is printed directly in the terminal.

## Example

```bash theme={null}
bazable explain POST https://api.example.com/v1/users
```

Example output:

```text theme={null}
--- Explanation for POST https://api.example.com/v1/users ---
This endpoint creates a new user. You must send a JSON body with `name` (string) and `email` (string). On success, it returns the created user object with an `id`, `name`, and `email`. Make sure the email is unique, the API may return an error if a duplicate is detected.
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.