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ção | Obrigatória (Token de API, Bearer) |
| Método HTTP | GET |
| Resposta | JSON |
| Versão | 1 |
| Cache | 1 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
| Objeto | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Response | customerId | int | sim | ID do cliente, resolvido a partir do access token |
| websiteId | int | sim | ID do site, resolvido a partir do access token | |
| version | string | sim | Versão do formato de configuração ("1.0.0") | |
| assistantName | string | não | Nome do assistente configurado pelo cliente | |
| welcomeMessage | string | não | Mensagem de boas-vindas configurada pelo cliente | |
| customPrompt | string | não | Prompt customizado de busca configurado pelo cliente | |
| chatMaxTokensPerRequest | int | sim | Limite de tokens por request de chat | |
| maxTokensPerConversation | int | sim | Limite de tokens por conversa completa | |
| chatEnabled | boolean | sim | Se o chat livre (modo conversacional) está habilitado para esta conta | |
| streamingEnabled | boolean | sim | Se o ambiente tem habilitado o modo streaming (SSE) para o chat | |
| chatTopics | Array of string | não | Tópicos habilitados que o assistente pode tratar | |
| chatTopicsCount | int | sim | Quantidade de tópicos em chatTopics | |
| enabled | boolean | sim | Se a conta tem um plano de IA ativo com tokens disponíveis | |
| monthlyTokenLimit | int | sim | Limite mensal de tokens do plano de IA (0 se não houver plano ativo) | |
| tokensUsed | int | sim | Tokens consumidos no período atual | |
| tokensRemaining | int | sim | Tokens disponíveis restantes no período atual | |
| totalProperties | int | sim | Total de propriedades publicadas do cliente | |
| aggregations | Aggregations | sim | Detalhamento do inventário publicado | |
| Aggregations | operations | Array of OperationCount | sim | Quantidade de propriedades por operação (venda, aluguel, etc.) |
| types | Array of TypeCount | sim | Quantidade de propriedades por tipo | |
| states | Array of ZoneCount | sim | Quantidade de propriedades por estado (zone1), com descrição | |
| counties | Array of ZoneCount | sim | Quantidade de propriedades por município/segunda divisão (zone2), com descrição e zone1Id do pai | |
| cities | Array of ZoneCount | sim | Quantidade de propriedades por cidade/bairro (zone3), com descrição e zone1Id/zone2Id dos pais | |
| currencies | Array of CurrencyStats | sim | Quantidade de propriedades e estatísticas de preço por moeda | |
| priceRanges | Array of PriceRange | não | Faixas de preço com quantidade de propriedades por moeda (somente se houver dados) | |
| OperationCount | id | int | sim | ID da operação. Constantes |
| description | string | sim | Descrição traduzida da operação | |
| count | int | sim | Quantidade de propriedades com essa operação | |
| TypeCount | id | int | sim | ID do tipo de propriedade. Constantes |
| description | string | sim | Descrição traduzida do tipo | |
| count | int | sim | Quantidade de propriedades com esse tipo | |
| ZoneCount | id | int | sim | ID da zona |
| description | string | não | Descrição da zona (pode faltar se não foi possível resolvê-la) | |
| count | int | sim | Quantidade de propriedades nessa zona | |
| zone1Id | int | não | ID do estado pai (somente em counties e cities) | |
| zone2Id | int | não | ID do município pai (somente em cities) | |
| CurrencyStats | currency | string | sim | Código da moeda (ex: ARS, USD) |
| count | int | sim | Quantidade de propriedades nessa moeda | |
| priceMin | int | não | Preço mínimo entre as propriedades dessa moeda | |
| priceMax | int | não | Preço máximo entre as propriedades dessa moeda | |
| priceAvg | int | não | Preço médio entre as propriedades dessa moeda | |
| PriceRange | currency | string | sim | Código da moeda da faixa |
| label | string | sim | Etiqueta da faixa de preço | |
| count | int | sim | Quantidade de propriedades nessa faixa | |
| from | int | não | Limite inferior da faixa (ausente na primeira faixa) | |
| to | int | não | Limite 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.