BETA

Mapaprop Chat AI API

API to integrate the Mapaprop Chat AI —the real estate AI assistant that qualifies leads and searches properties in natural language— into your own applications and channels: custom websites, mobile apps, WhatsApp and other messaging platforms.

BETA. The AI engine is production-tested (it's the same engine used by the Chat AI on Mapaprop sites), but this OAuth API surface is in BETA: the endpoint contract may change and there is no rate limiting defined yet. Integrate with that expectation in mind. Write to us at dev@mapaprop.com if you're planning to integrate, so we can let you know about any change.

The engine already runs in production inside the Mapaprop ecosystem: it understands natural language queries, searches the customer's real inventory through semantic search, replies with concrete properties and captures the interested visitor's data as a qualified lead. Generated leads stay in the customer's Mapaprop account, integrated with their Inbox and CRM.

Integration modes

Full Stack. Your application sends the visitor's messages and Mapaprop orchestrates everything: the AI, the inventory search and the response generation. You receive a ready-to-display answer. It's the simplest mode to integrate and the one covered by this documentation.

Authentication

This API works with your Mapaprop API Token, not with the third-party OAuth2 app registration. If you're already a Mapaprop Business customer, you activate your token with one click from your account —Settings > API Token— and use it as Authorization: Bearer {token}. The token does not expire (unless you regenerate or deactivate it). Step-by-step guide: MapapropChatAi API Token.

There's no need to register any application or request authorization: the token is self-service for customers on the Business plan. The OAuth2 flow from Getting Started is for portals and third parties (Feeds/Customer/Network/Property API), not for this API.

All endpoints require the mapaprop-chat-ai scope (included in your token if you have Business). The account identity (customerId / websiteId) is derived from the token, it is not sent as a parameter: each token operates on the inventory and leads of the Mapaprop account it belongs to.

If your integration runs in the browser (serverless webapp), enable the CORS scope from the same screen. See CORS (cross-origin).

Basic flow

Start the conversation with POST /init. Returns the questionId (the conversation identifier) and the configured welcome message. Does not consume AI tokens.
Send each visitor message with POST /chat (full response) or POST /chat/stream (SSE streaming response), always resending the questionId. These endpoints consume the customer's AI tokens.
Persist the steps of the guided flow (Sale/Rent buttons, etc.) with POST /thread and standalone messages with POST /message. They do not invoke AI.
The visitor's data (name, email, phone) that you send in the conversation becomes a qualified lead in the customer's CRM.

Every response from POST /chat and POST /chat/stream includes the conversation's questionId. Save it and resend it on the next turn to keep the thread going. POST /init is useful when you want to create the conversation and show the welcome message before the visitor's first message.

Endpoints

Availability

Included in the Mapaprop Business plan. The mapaprop-chat-ai scope is added to your API Token when your account has Business active.
It's self-service: no app registration, no client_secret, and no prior approval required.

How to activate your token

Go to Settings > API Token in your Mapaprop account.
Press Activate and copy the token (a single step).
Use it as Authorization: Bearer {token} in the calls to this API.

Guide with screenshots: MapapropChatAi API Token. If you don't have the Business plan yet, you can subscribe to it from your account.