API Overview

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

Include your API key in every request:

X-ARIS-API-Key: aris_yourkey

See Authentication for details on creating and managing keys.

Send a message, receive a streamed AI response.

Get widget display configuration.

Search MLS property listings.

Get featured/promoted listings.

All errors return a JSON object with an error field:

{
  "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

The full OpenAPI 3.1 specification is available at docs/openapi.yaml in the repository.