Documentação da API

Documentação da API

A funcionalidade de geração de insights também está disponível através de uma API REST.
Para a especificação completa, consulte o nosso endpoint OpenAPI.

Endpoint de Insight (GET)

Use uma requisição GET para verificar o status da API e obter um modelo de dados para o POST.

GET /api/insight

Exemplo de Resposta (GET)

{
  "status": "ok",
  "message": "API está operacional. Use o método POST com o corpo abaixo para gerar insights.",
  "post_template": {
    "nome_fazenda": "Fazenda Bela Vista",
    "sistema_producao": "Compost Barn",
    "vacas_em_lactacao": 85,
    "vacas_totais": 100,
    "animais_totais": 150,
    "funcionarios": 4,
    "area": 50,
    "producao_media_leite": 28,
    "ccs": 350,
    "preco_leite": 2.68
  }
}

Endpoint de Insight (POST)

Envie uma requisição POST com os dados da fazenda para gerar os insights.

POST /api/insight

Exemplo de Requisição (cURL)

Abaixo está um exemplo de como chamar a API usando cURL. O corpo da requisição deve ser um objeto JSON com as métricas da fazenda.

curl -X POST -H "Content-Type: application/json" -d '{
  "nome_fazenda": "Fazenda Bela Vista",
  "sistema_producao": "Compost Barn",
  "vacas_em_lactacao": 85,
  "vacas_totais": 100,
  "animais_totais": 150,
  "funcionarios": 4,
  "area": 50,
  "producao_media_leite": 28,
  "ccs": 350,
  "preco_leite": 2.68
}' https://insights.educampo.cloud/api/insight

Exemplo de Resposta (POST)

Uma requisição bem-sucedida retornará um objeto JSON com a análise completa.

{
      "analise_descritiva": {
        "metricas_usuario": { ... },
        "benchmarks_por_faixa": { ... },
        "sistema": "Compost Barn",
        "faixa_producao_usuario": "Acima de 2.000 L/dia"
      },
      "insights_baseados_regras": [
        {
          "chave": "ccs",
          "indicador": "CCS (x1000 células/mL)",
          "valor_usuario": 350.00,
          "insight": "Alerta: Risco de perda de bonificações por qualidade...",
          "unidade": "mil"
        }
      ],
      "resumo_geral": {
        "resumo": "Sua fazenda demonstra um desempenho equilibrado..."
      }
    }

Endpoint de Chat (POST)

Envie uma mensagem para interagir com o modelo de IA.

POST /api/chat

Exemplo de Requisição (cURL)

curl -X POST -H "Content-Type: application/json" -d '{"message": "Olá, qual a sua função?"}' https://insights.educampo.cloud/api/chat

Exemplo de Resposta (POST)

{
      "message": "Olá! Eu sou um assistente de IA treinado para fornecer insights sobre a pecuária leiteira. Como posso ajudar você hoje?"
    }