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

# API Overview

> Programmatic access to the ARIS AI engine, MLS listings, and widget configuration.

The ARIS REST API provides programmatic access to the AI conversation engine, widget configuration, and MLS listing data.

## Base URL

```
https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router
```

## Authentication

Include your API key in every request:

```
X-ARIS-API-Key: aris_yourkey
```

See [Authentication](/docs/getting-started/authentication) for details on creating and managing keys.

## Endpoints

<CardGroup cols={2}>
  <Card title="POST /v1/chat" icon="message" href="/docs/api/chat">
    Send a message, receive a streamed AI response.
  </Card>

  <Card title="GET /v1/config" icon="gear" href="/docs/api/config">
    Get widget display configuration.
  </Card>

  <Card title="POST /v1/listings/search" icon="magnifying-glass" href="/docs/api/listings-search">
    Search MLS property listings.
  </Card>

  <Card title="POST /v1/listings/featured" icon="star" href="/docs/api/listings-featured">
    Get featured/promoted listings.
  </Card>
</CardGroup>

## Error format

All errors return a JSON object with an `error` field:

```json theme={null}
{
  "error": "brokerageId is required"
}
```

| Status | Meaning                                     |
| ------ | ------------------------------------------- |
| `400`  | Bad request — missing or invalid parameters |
| `401`  | Invalid or missing API key                  |
| `402`  | Monthly credit quota exhausted              |
| `403`  | brokerageId does not match API key          |
| `404`  | Brokerage or route not found                |
| `429`  | Rate limit exceeded                         |
| `500`  | Internal server error                       |

## OpenAPI spec

The full OpenAPI 3.1 specification is available at [`docs/openapi.yaml`](https://github.com/thezpack/ai-mls-chatbot/blob/main/docs/openapi.yaml) in the repository.