Skip to main content
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 for details on creating and managing keys.

Endpoints

Error format

All errors return a JSON object with an error field:
{
  "error": "brokerageId is required"
}
StatusMeaning
400Bad request — missing or invalid parameters
401Invalid or missing API key
402Monthly credit quota exhausted
403brokerageId does not match API key
404Brokerage or route not found
429Rate limit exceeded
500Internal server error

OpenAPI spec

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