BETA

Retorna a configuração do Chat AI da conta autenticada pelo token: nome do assistente, mensagem de boas-vindas, tópicos habilitados, limites de tokens e um resumo agregado do inventário de propriedades (totais e detalhamentos por operação, tipo e zona).

customerId e websiteId são resolvidos a partir do access token, nunca de um parâmetro.

Informações do recurso
AutenticaçãoObrigatória (Token de API, Bearer)
Método HTTPGET
RespostaJSON
Versão1
Cache1 hora

URL do recurso

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

Parâmetros

Este endpoint não recebe parâmetros.

Código de exemplo

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}

Resposta

ObjetoCampoTipoObrigatórioDescrição
ResponsecustomerIdintsimID do cliente, resolvido a partir do access token
websiteIdintsimID do site, resolvido a partir do access token
versionstringsimVersão do formato de configuração ("1.0.0")
assistantNamestringnãoNome do assistente configurado pelo cliente
welcomeMessagestringnãoMensagem de boas-vindas configurada pelo cliente
customPromptstringnãoPrompt customizado de busca configurado pelo cliente
chatMaxTokensPerRequestintsimLimite de tokens por request de chat
maxTokensPerConversationintsimLimite de tokens por conversa completa
chatEnabledbooleansimSe o chat livre (modo conversacional) está habilitado para esta conta
streamingEnabledbooleansimSe o ambiente tem habilitado o modo streaming (SSE) para o chat
chatTopicsArray of stringnãoTópicos habilitados que o assistente pode tratar
chatTopicsCountintsimQuantidade de tópicos em chatTopics
enabledbooleansimSe a conta tem um plano de IA ativo com tokens disponíveis
monthlyTokenLimitintsimLimite mensal de tokens do plano de IA (0 se não houver plano ativo)
tokensUsedintsimTokens consumidos no período atual
tokensRemainingintsimTokens disponíveis restantes no período atual
totalPropertiesintsimTotal de propriedades publicadas do cliente
aggregationsAggregationssimDetalhamento do inventário publicado
AggregationsoperationsArray of OperationCountsimQuantidade de propriedades por operação (venda, aluguel, etc.)
typesArray of TypeCountsimQuantidade de propriedades por tipo
statesArray of ZoneCountsimQuantidade de propriedades por estado (zone1), com descrição
countiesArray of ZoneCountsimQuantidade de propriedades por município/segunda divisão (zone2), com descrição e zone1Id do pai
citiesArray of ZoneCountsimQuantidade de propriedades por cidade/bairro (zone3), com descrição e zone1Id/zone2Id dos pais
currenciesArray of CurrencyStatssimQuantidade de propriedades e estatísticas de preço por moeda
priceRangesArray of PriceRangenãoFaixas de preço com quantidade de propriedades por moeda (somente se houver dados)
OperationCountidintsimID da operação. Constantes
descriptionstringsimDescrição traduzida da operação
countintsimQuantidade de propriedades com essa operação
TypeCountidintsimID do tipo de propriedade. Constantes
descriptionstringsimDescrição traduzida do tipo
countintsimQuantidade de propriedades com esse tipo
ZoneCountidintsimID da zona
descriptionstringnãoDescrição da zona (pode faltar se não foi possível resolvê-la)
countintsimQuantidade de propriedades nessa zona
zone1IdintnãoID do estado pai (somente em counties e cities)
zone2IdintnãoID do município pai (somente em cities)
CurrencyStatscurrencystringsimCódigo da moeda (ex: ARS, USD)
countintsimQuantidade de propriedades nessa moeda
priceMinintnãoPreço mínimo entre as propriedades dessa moeda
priceMaxintnãoPreço máximo entre as propriedades dessa moeda
priceAvgintnãoPreço médio entre as propriedades dessa moeda
PriceRangecurrencystringsimCódigo da moeda da faixa
labelstringsimEtiqueta da faixa de preço
countintsimQuantidade de propriedades nessa faixa
fromintnãoLimite inferior da faixa (ausente na primeira faixa)
tointnãoLimite superior da faixa (ausente na última faixa)

Exemplo de resposta

{
    "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 neste endpoint inclui description para states/counties/cities (e a hierarquia zone1Id/zone2Id). O endpoint GET /api/action/mapaprop-chat-ai-v1/search retorna a mesma forma de aggregations, mas sem enriquecer states/counties/cities com descrição.