Insights

Gera análises, resumos e relatórios de conversas.

Listar templates de insights de chat

get

Autorizações

ApiKeyAuth

AuthorizationstringObrigatório

Respostas

200

Retorna os templates de insights de chat disponíveis para o tenant.

application/json

401

Falha de autenticação da chave de API.

application/json

get

/api/v3/insights_chat

HTTPcURLJavaScriptPython

GET /my-tenant/api/v3/insights_chat HTTP/1.1
Host: app.genier.ai
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "1",
      "name": "Suporte",
      "type": "chat",
      "cat": "support",
      "insights": true,
      "insights_prompt": "Faça uma análise do atendimento de suporte e gere insights relevantes",
      "resume": true,
      "resume_prompt": "Faça um resumo do atendimento de suporte em um parágrafo",
      "sentimental": true,
      "sentimental_prompt": "Retorne umas das opções (Positivo,Neutro,Negativo) da conversa",
      "tags": true,
      "tags_prompt": "Gere tags relevantes para o atendimento de suporte sempre iniciando com #",
      "m_like": true,
      "m_like_prompt": "Analise se o atendimento foi satisfatório do ponto de vista do usuário. Retorne 'true' se o usuário ficou satisfeito ou 'false' se ficou insatisfeito"
    }
  ]
}

Enfileirar análise de conversa via workflow de insights de chat

post

Autorizações

ApiKeyAuth

AuthorizationstringObrigatório

Corpo

application/json

idstringObrigatório

Identificador único da requisição (ex.: ID da sessão)

insight_chat_idstringObrigatório

ID do template de insights de chat a ser usado

urlstring · uriObrigatório

URL do webhook que receberá o resultado

challengestringOpcional

Token opcional enviado como Bearer no callback

dataobjectObrigatório

Payload com histórico ou metadados da conversa a ser analisada

m_likeinteger · int32Opcional

Avaliação opcional do usuário (1 = positivo, 0 = negativo)

Respostas

202

Enfileira a solicitação e retorna o identificador do workflow.

application/json

400

Rejeita quando campos obrigatórios não foram informados.

application/json

401

Falha de autenticação da chave de API.

application/json

404

Não encontra o template solicitado.

application/json

409

Indica que já existe um workflow em execução para o ID informado.

application/json

500

Falha interna ao enfileirar o workflow.

application/json

post

/api/v3/insights_chat

HTTPcURLJavaScriptPython

POST /my-tenant/api/v3/insights_chat HTTP/1.1
Host: app.genier.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "id": "session-123",
  "insight_chat_id": "4f8ba8d7-090e-4a29-9e63-1f2d2f9e0c7a",
  "url": "https://webhook.seusistema.com/retorno-insights",
  "challenge": "token-opcional",
  "m_like": 1,
  "data": {
    "conversation": [
      {
        "from": "cliente",
        "text": "Olá, preciso de ajuda com minha fatura."
      },
      {
        "from": "atendente",
        "text": "Claro, posso verificar isso para você."
      }
    ]
  }
}

{
  "status": "queued",
  "id": "session-123",
  "workflow_id": "insights-chat-automacao-session-123-abc123"
}

Buscar template específico de insights de chat

get

Autorizações

ApiKeyAuth

AuthorizationstringObrigatório

Parâmetros de rota

insight_idstringObrigatório

ID do template salvo

Respostas

200

Retorna o template de insights solicitado.

application/json

401

Falha de autenticação da chave de API.

application/json

404

Não encontra o template informado.

application/json

get

/api/v3/insights_chat/{insight_id}

HTTPcURLJavaScriptPython

GET /my-tenant/api/v3/insights_chat/{insight_id} HTTP/1.1
Host: app.genier.ai
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "4f8ba8d7-090e-4a29-9e63-1f2d2f9e0c7a",
    "name": "Comercial",
    "description": "Template de insights comerciais",
    "type": "chat",
    "cat": "sales",
    "insights": true,
    "insights_prompt": "Identifique oportunidades de upsell e pontos de atrito.",
    "conversation": true,
    "resume": true,
    "resume_prompt": "Resuma os principais pontos tratados.",
    "sentimental": true,
    "sentimental_prompt": "Classifique o sentimento do cliente.",
    "tags": true,
    "tags_prompt": "Extraia até 3 tags relevantes.",
    "m_like": true,
    "m_like_prompt": "Analise se o atendimento foi satisfatório."
  }
}

Gerar insights imediatos de chat (legado)

post

Autorizações

ApiKeyAuth

AuthorizationstringObrigatório

Corpo

application/json

user_instructionsstringObrigatório

Instruções para orientar a análise do LLM

Respostas

200

Retorna os insights gerados pelo LLM.

application/json

400

Rejeita quando o corpo é inválido ou faltam campos obrigatórios.

application/json

401

Falha de autenticação da chave de API.

application/json

post

/api/v3/chat_insights

HTTPcURLJavaScriptPython

POST /my-tenant/api/v3/chat_insights HTTP/1.1
Host: app.genier.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 569

{
  "user_instructions": "Analise a conversa e identifique as principais necessidades do cliente. Crie tags relacionadas ao atendimento ao cliente e vendas.",
  "history": [
    {
      "input": "Olá, preciso de ajuda com meu pedido",
      "output": "Olá! Claro, posso ajudar com seu pedido. Qual é o número do seu pedido?"
    },
    {
      "input": "É o pedido 12345",
      "output": "Encontrei seu pedido 12345. Ele está em processamento. Qual é sua dúvida?"
    },
    {
      "input": "Quando será entregue?",
      "output": "Seu pedido será entregue em até 3 dias úteis. Você receberá um código de rastreamento por email."
    }
  ]
}

{
  "response": {
    "resumo": "O cliente entrou em contato para obter informações sobre o status do pedido e recebeu prazo de entrega.",
    "tags": [
      "#atendimento",
      "#pedido",
      "#entrega",
      "#suporte"
    ],
    "sentimental": {
      "sentimento": "Positivo"
    }
  }
}

Consultar relatórios de insights com filtros e paginação

get

Autorizações

ApiKeyAuth

AuthorizationstringObrigatório

Parâmetros de consulta

pageintegerOpcional

Define o número da página, iniciando em 1.

Default: 1

items_per_pageintegerOpcional

Define a quantidade de itens por página (máximo 100).

Default: 5

order_bystring · enumOpcional

Define o campo usado para ordenar os resultados.

Default: created_atValores possíveis:

order_directionstring · enumOpcional

Define a direção da ordenação.

Default: descValores possíveis:

tagsstring[]Opcional

Filtra resultados pelas tags informadas (aceita múltiplas entradas).

tags_matchstring · enumOpcional

Define como as tags devem corresponder (all exige todas, any aceita qualquer uma).

Default: allValores possíveis:

search_filterstringOpcional

Aplica filtro textual aos campos indexados.

agent_idstringOpcional

Filtra pelo ID do agente.

date_typestring · enumOpcional

Define o tipo de filtro de data.

Valores possíveis:

relative_daysintegerOpcional

Define a quantidade de dias para filtro relativo.

start_datetimestring · date-timeOpcional

Define a data/hora inicial para filtro absoluto (ISO 8601).

end_datetimestring · date-timeOpcional

Define a data/hora final para filtro absoluto (ISO 8601).

downloadbooleanOpcional

Inclui o histórico completo quando definido como true.

Default: false

Respostas

200

Retorna lista paginada de curadorias e metadados dos filtros aplicados.

application/json

401

Falha de autenticação da chave de API.

application/json

500

Falha interna ao recuperar os insights.

application/json

get

/api/v3/reports/insights

HTTPcURLJavaScriptPython

GET /my-tenant/api/v3/reports/insights HTTP/1.1
Host: app.genier.ai
Authorization: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "agent_id": "uuid-do-agente",
      "curator_id": "uuid-do-curador",
      "agent_name": "Nome do Agente",
      "m_like": 1,
      "completed": 1,
      "insights": "Insights da conversa...",
      "created_at": "2023-12-01T10:00:00",
      "score": 4.5,
      "response_time": 1200,
      "interaction_count": 5,
      "message_count": 10,
      "workflow_name": "atendimento",
      "platform": "whatsapp",
      "initial_time": "2023-12-01T09:58:00",
      "final_time": "2023-12-01T10:02:00",
      "tags": [
        "#vendas",
        "#suporte"
      ],
      "filters": [
        "filtro1",
        "filtro2"
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "items_per_page": 5,
    "total_items": 100,
    "total_pages": 20
  },
  "filters": {
    "order_by": "created_at",
    "order_direction": "desc",
    "tags": [],
    "tags_match": "all",
    "search_filter": "",
    "agent_id": null,
    "date_filter": {
      "date_type": null,
      "relative_days": null,
      "start_datetime": null,
      "end_datetime": null,
      "applied": false
    }
  }
}

Executar curadoria de conversa

post

Autorizações

ApiKeyAuth

AuthorizationstringObrigatório

Corpo

application/json

agent_idstringObrigatório

workflow_namestringObrigatório

platformstringObrigatório

initial_timestringObrigatório

final_timestringObrigatório

Respostas

200

Retorna o resultado da curadoria executada.

application/json

messagestringOpcional

400

Rejeita quando faltam parâmetros obrigatórios.

application/json

401

Falha de autenticação da chave de API.

application/json

500

Falha interna ao processar a curadoria.

application/json

post

/api/v3/go_curator

HTTPcURLJavaScriptPython

POST /my-tenant/api/v3/go_curator HTTP/1.1
Host: app.genier.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "agent_id": "agent_123",
  "workflow_name": "atendimento",
  "platform": "whatsapp",
  "history": [
    {
      "input": "oi",
      "output": "Olá!"
    }
  ],
  "initial_time": "2024-01-01T10:00:00",
  "final_time": "2024-01-01T10:05:00"
}

{
  "message": "Curadoria executada com sucesso."
}