Base URL
Authentication
Include your API key in every request:Endpoints
POST /v1/chat
Send a message, receive a streamed AI response.
GET /v1/config
Get widget display configuration.
POST /v1/listings/search
Search MLS property listings.
POST /v1/listings/featured
Get featured/promoted listings.
Error format
All errors return a JSON object with anerror field:
| 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 atdocs/openapi.yaml in the repository.