BETA

Returns the Chat AI configuration of the account authenticated by the token: assistant name, welcome message, enabled topics, token limits and an aggregated summary of the property inventory (totals and breakdowns by operation, type and zone).

customerId and websiteId are resolved from the access token, never from a parameter.

Resource information
AuthenticationRequired (API Token, Bearer)
HTTP MethodGET
ResponseJSON
Version1
Cache1 hour

Resource URL

https://mapaprop.app/api/action/mapaprop-chat-ai-v1/config

Parameters

This endpoint does not receive parameters.

Sample code

GET /api/action/mapaprop-chat-ai-v1/config HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Response

ObjectFieldTypeRequiredDescription
ResponsecustomerIdintyesCustomer ID, resolved from the access token
websiteIdintyesWebsite ID, resolved from the access token
versionstringyesVersion of the configuration format ("1.0.0")
assistantNamestringnoAssistant name configured by the customer
welcomeMessagestringnoWelcome message configured by the customer
customPromptstringnoCustom search prompt configured by the customer
chatMaxTokensPerRequestintyesToken limit per chat request
maxTokensPerConversationintyesToken limit for the entire conversation
chatEnabledbooleanyesWhether free chat (conversational mode) is enabled for this account
streamingEnabledbooleanyesWhether the environment has streaming mode (SSE) enabled for chat
chatTopicsArray of stringnoEnabled topics the assistant can cover
chatTopicsCountintyesNumber of topics in chatTopics
enabledbooleanyesWhether the account has an active AI plan with tokens available
monthlyTokenLimitintyesMonthly token limit of the AI plan (0 if there is no active plan)
tokensUsedintyesTokens consumed in the current period
tokensRemainingintyesTokens remaining in the current period
totalPropertiesintyesTotal published properties of the customer
aggregationsAggregationsyesBreakdown of the published inventory
AggregationsoperationsArray of OperationCountyesNumber of properties by operation (sale, rent, etc.)
typesArray of TypeCountyesNumber of properties by type
statesArray of ZoneCountyesNumber of properties by state/province (zone1), with description
countiesArray of ZoneCountyesNumber of properties by county (zone2), with description and parent zone1Id
citiesArray of ZoneCountyesNumber of properties by city/neighborhood (zone3), with description and parent zone1Id/zone2Id
currenciesArray of CurrencyStatsyesNumber of properties and price statistics by currency
priceRangesArray of PriceRangenoPrice ranges with number of properties by currency (only if there is data)
OperationCountidintyesOperation ID. Constants
descriptionstringyesTranslated description of the operation
countintyesNumber of properties with that operation
TypeCountidintyesProperty type ID. Constants
descriptionstringyesTranslated description of the type
countintyesNumber of properties with that type
ZoneCountidintyesZone ID
descriptionstringnoZone description (may be missing if it could not be resolved)
countintyesNumber of properties in that zone
zone1IdintnoParent state ID (only in counties and cities)
zone2IdintnoParent county ID (only in cities)
CurrencyStatscurrencystringyesCurrency code (e.g. ARS, USD)
countintyesNumber of properties in that currency
priceMinintnoMinimum price among the properties in that currency
priceMaxintnoMaximum price among the properties in that currency
priceAvgintnoAverage price among the properties in that currency
PriceRangecurrencystringyesCurrency code of the range
labelstringyesLabel of the price range
countintyesNumber of properties in that range
fromintnoLower bound of the range (absent in the first range)
tointnoUpper bound of the range (absent in the last range)

Sample response

{
    "customerId": 11099,
    "websiteId": 4521,
    "version": "1.0.0",
    "assistantName": "Sofía",
    "welcomeMessage": "¡Hola! Soy Sofía, ¿en qué propiedad estás interesado?",
    "customPrompt": "",
    "chatMaxTokensPerRequest": 4000,
    "maxTokensPerConversation": 20000,
    "chatEnabled": true,
    "streamingEnabled": false,
    "chatTopics": ["Venta", "Alquiler", "Financiación"],
    "chatTopicsCount": 3,
    "enabled": true,
    "monthlyTokenLimit": 500000,
    "tokensUsed": 128340,
    "tokensRemaining": 371660,
    "totalProperties": 84,
    "aggregations": {
        "operations": [
            { "id": 1, "description": "Venta", "count": 52 },
            { "id": 2, "description": "Alquiler", "count": 32 }
        ],
        "types": [
            { "id": 1, "description": "Departamento", "count": 40 },
            { "id": 2, "description": "Casa", "count": 30 }
        ],
        "states": [
            { "id": 1, "description": "Capital Federal", "count": 60 }
        ],
        "counties": [
            { "id": 46, "description": "Palermo", "zone1Id": 1, "count": 25 }
        ],
        "cities": [],
        "currencies": [
            { "currency": "USD", "count": 70, "priceMin": 50000, "priceMax": 800000, "priceAvg": 210000 }
        ],
        "priceRanges": [
            { "currency": "USD", "label": "0-100000", "count": 20, "to": 100000 },
            { "currency": "USD", "label": "100000-300000", "count": 35, "from": 100000, "to": 300000 }
        ]
    }
}

aggregations in this endpoint includes description for states/counties/cities (and the zone1Id/zone2Id hierarchy). The GET /api/action/mapaprop-chat-ai-v1/search endpoint returns the same aggregations shape but without enriching states/counties/cities with description.