Consumo por agentes e integrações

Conteúdo estruturado para sistemas, LLMs e automações.

Esta página descreve os endpoints estáveis, a semântica dos campos e os limites de uso para agentes consumirem o conteúdo com baixa ambiguidade.

Abrir agent.json Abrir llms.txt

Endpoints recomendados

/v1/high-alertsAlertas altos e críticos por município, doença e vírus. /v1/risk-indexÍndice enriquecido com filtros por município, UF e nível mínimo. /v1/diseasesCatálogo de doenças e agravos suportados pela API. /v1/bairrosLista agrupada de bairros/distritos (SP, RJ, MG, PE) para busca por nome (resolve para município). /v1/metadataFontes, ano, status da carga e fórmula de risco. /openapi.jsonContrato OpenAPI para geração de clientes e ferramentas.

Exemplo

GET /v1/high-alerts?estado=SP&limite=10
GET /v1/risk-index?municipio=perus&estado=SP&somente_altos=false

Regras de interpretação

Use nivel_risco para priorização, risk_score para ordenação, /v1/diseases para descobrir agravos carregados e filtro_localidade para identificar quando a consulta original foi feita por um bairro ou distrito (suportado em SP, RJ, MG e PE). O sistema resolve o nome para o município correspondente — a granularidade dos dados continua municipal.

Bairros e distritos suportados (multi-cidade)

O sistema resolve nomes de bairros e distritos para o município oficial (granularidade sempre municipal). Atualmente suportamos São Paulo (distritos), Rio de Janeiro, Belo Horizonte e Recife. Ao usar um destes nomes no parâmetro municipio, a resposta inclui filtro_localidade com a origem da consulta.

Exemplos de buscas que funcionam:

perus grajaú copacabana ipanema savassi pampulha boa viagem madalena

Lista completa e estruturada: GET /v1/bairros (retorna todas as cidades com seus bairros em formato agrupado).

Dica para agentes: Prefira buscar pelo nome do bairro quando estiver em campo. O sistema entrega os dados do município com o contexto da origem (bairro → município).