API Reference

Send a message and receive an AI response

Sends a conversation turn to the ARIS AI engine and streams back a response. The AI classifies the intent, invokes tools (property search, mortgage calculator, etc.) as needed, and returns a natural-language reply with any relevant listing data embedded in the stream.

Responses are streamed as Server-Sent Events (SSE) in OpenAI-compatible delta format. The final event is data: [DONE].

Intent types handled automatically: property_search, property_question, general_question, correction, contact_info, scheduling, small_talk, off_topic, follow_up, comparison, affordability, negotiation, location_info

POST

chat

Send a message and receive an AI response

curl --request POST \
  --url https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/chat \
  --header 'Content-Type: application/json' \
  --header 'X-ARIS-API-Key: <api-key>' \
  --data '
{
  "brokerageId": "550e8400-e29b-41d4-a716-446655440000",
  "sessionId": "session_abc123",
  "messages": [
    {
      "role": "user",
      "content": "Show me 3-bedroom homes under $500k in Austin"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'X-ARIS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brokerageId: '550e8400-e29b-41d4-a716-446655440000',
    sessionId: 'session_abc123',
    messages: [{role: 'user', content: 'Show me 3-bedroom homes under $500k in Austin'}]
  })
};

fetch('https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/chat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/chat"

payload = {
    "brokerageId": "550e8400-e29b-41d4-a716-446655440000",
    "sessionId": "session_abc123",
    "messages": [
        {
            "role": "user",
            "content": "Show me 3-bedroom homes under $500k in Austin"
        }
    ]
}
headers = {
    "X-ARIS-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "error": "brokerageId is required"
}

{
  "error": "brokerageId is required"
}

{
  "error": "brokerageId is required"
}

{
  "error": "brokerageId is required"
}

Authorizations

X-ARIS-API-Key

string

header

required

Body

application/json

messages

object[]

required

Full conversation history, most recent message last.

Minimum array length: 1

Show child attributes

brokerageId

string

required

The brokerage ID associated with your API key.

Example:

"550e8400-e29b-41d4-a716-446655440000"

sessionId

string

Optional session identifier for conversation memory persistence. If omitted, a new session ID is generated and returned in the stream's final metadata event. Reuse the same sessionId across turns to maintain context (remembered preferences, prior listings, etc.).

Example:

"session_abc123"

Response

SSE stream. Content-Type is text/event-stream. Each event follows OpenAI delta format. Property listing data is embedded in the stream using HTML comment markers () parsed by the widget renderer.

Send a message and receive an AI response

curl --request POST \
  --url https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/chat \
  --header 'Content-Type: application/json' \
  --header 'X-ARIS-API-Key: <api-key>' \
  --data '
{
  "brokerageId": "550e8400-e29b-41d4-a716-446655440000",
  "sessionId": "session_abc123",
  "messages": [
    {
      "role": "user",
      "content": "Show me 3-bedroom homes under $500k in Austin"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'X-ARIS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brokerageId: '550e8400-e29b-41d4-a716-446655440000',
    sessionId: 'session_abc123',
    messages: [{role: 'user', content: 'Show me 3-bedroom homes under $500k in Austin'}]
  })
};

fetch('https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/chat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/chat"

payload = {
    "brokerageId": "550e8400-e29b-41d4-a716-446655440000",
    "sessionId": "session_abc123",
    "messages": [
        {
            "role": "user",
            "content": "Show me 3-bedroom homes under $500k in Austin"
        }
    ]
}
headers = {
    "X-ARIS-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "error": "brokerageId is required"
}

{
  "error": "brokerageId is required"
}

{
  "error": "brokerageId is required"
}

{
  "error": "brokerageId is required"
}

Overview

Endpoints

Send a message and receive an AI response

Authorizations

Body

Response