# Insights

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

## GET /api/v3/insights\_chat

> Listar templates de insights de chat

```json
{"openapi":"3.0.3","info":{"title":"Genier API v3","version":"3.12.0"},"tags":[{"name":"Insights","description":"Gera análises, resumos e relatórios de conversas."}],"servers":[{"url":"https://{host}/{tenant}","description":"Define o host e o tenant usados nas chamadas.","variables":{"host":{"default":"app.genier.ai"},"tenant":{"default":"my-tenant"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"InsightsChatListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InsightsChatTemplate"}}}},"InsightsChatTemplate":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","description":"Tipo de pipeline (sempre \"chat\")"},"cat":{"type":"string","description":"Categoria do template"},"insights":{"type":"boolean","description":"Habilita geração de insights detalhados"},"insights_prompt":{"type":"string"},"conversation":{"type":"boolean","description":"Define se o template inclui análise de conversa completa"},"resume":{"type":"boolean","description":"Habilita resumo do atendimento"},"resume_prompt":{"type":"string"},"sentimental":{"type":"boolean","description":"Habilita análise de sentimento"},"sentimental_prompt":{"type":"string"},"tags":{"type":"boolean","description":"Habilita extração de tags"},"tags_prompt":{"type":"string"},"m_like":{"type":"boolean","description":"Habilita avaliação de satisfação (like/dislike)"},"m_like_prompt":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v3/insights_chat":{"get":{"summary":"Listar templates de insights de chat","tags":["Insights"],"responses":{"200":{"description":"Retorna os templates de insights de chat disponíveis para o tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsChatListResponse"}}}},"401":{"description":"Falha de autenticação da chave de API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /api/v3/insights\_chat

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

```json
{"openapi":"3.0.3","info":{"title":"Genier API v3","version":"3.12.0"},"tags":[{"name":"Insights","description":"Gera análises, resumos e relatórios de conversas."}],"servers":[{"url":"https://{host}/{tenant}","description":"Define o host e o tenant usados nas chamadas.","variables":{"host":{"default":"app.genier.ai"},"tenant":{"default":"my-tenant"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"InsightsChatCreateRequest":{"type":"object","required":["id","insight_chat_id","url","data"],"properties":{"id":{"type":"string","description":"Identificador único da requisição (ex.: ID da sessão)"},"insight_chat_id":{"type":"string","description":"ID do template de insights de chat a ser usado"},"url":{"type":"string","format":"uri","description":"URL do webhook que receberá o resultado"},"challenge":{"type":"string","description":"Token opcional enviado como Bearer no callback"},"data":{"type":"object","description":"Payload com histórico ou metadados da conversa a ser analisada"},"m_like":{"type":"integer","format":"int32","description":"Avaliação opcional do usuário (1 = positivo, 0 = negativo)"}}},"InsightsChatQueuedResponse":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"},"workflow_id":{"type":"string"}}},"MissingFieldsResponse":{"type":"object","properties":{"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}},"WorkflowAlreadyStartedResponse":{"type":"object","properties":{"message":{"type":"string"},"workflow_id":{"type":"string"},"id":{"type":"string"}}}}},"paths":{"/api/v3/insights_chat":{"post":{"summary":"Enfileirar análise de conversa via workflow de insights de chat","tags":["Insights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsChatCreateRequest"}}}},"responses":{"202":{"description":"Enfileira a solicitação e retorna o identificador do workflow.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsChatQueuedResponse"}}}},"400":{"description":"Rejeita quando campos obrigatórios não foram informados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingFieldsResponse"}}}},"401":{"description":"Falha de autenticação da chave de API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Não encontra o template solicitado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Indica que já existe um workflow em execução para o ID informado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowAlreadyStartedResponse"}}}},"500":{"description":"Falha interna ao enfileirar o workflow.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /api/v3/insights\_chat/{insight\_id}

> Buscar template específico de insights de chat

```json
{"openapi":"3.0.3","info":{"title":"Genier API v3","version":"3.12.0"},"tags":[{"name":"Insights","description":"Gera análises, resumos e relatórios de conversas."}],"servers":[{"url":"https://{host}/{tenant}","description":"Define o host e o tenant usados nas chamadas.","variables":{"host":{"default":"app.genier.ai"},"tenant":{"default":"my-tenant"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"InsightsChatTemplateResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InsightsChatTemplate"}}},"InsightsChatTemplate":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","description":"Tipo de pipeline (sempre \"chat\")"},"cat":{"type":"string","description":"Categoria do template"},"insights":{"type":"boolean","description":"Habilita geração de insights detalhados"},"insights_prompt":{"type":"string"},"conversation":{"type":"boolean","description":"Define se o template inclui análise de conversa completa"},"resume":{"type":"boolean","description":"Habilita resumo do atendimento"},"resume_prompt":{"type":"string"},"sentimental":{"type":"boolean","description":"Habilita análise de sentimento"},"sentimental_prompt":{"type":"string"},"tags":{"type":"boolean","description":"Habilita extração de tags"},"tags_prompt":{"type":"string"},"m_like":{"type":"boolean","description":"Habilita avaliação de satisfação (like/dislike)"},"m_like_prompt":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v3/insights_chat/{insight_id}":{"get":{"summary":"Buscar template específico de insights de chat","tags":["Insights"],"parameters":[{"name":"insight_id","in":"path","required":true,"schema":{"type":"string"},"description":"ID do template salvo"}],"responses":{"200":{"description":"Retorna o template de insights solicitado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsChatTemplateResponse"}}}},"401":{"description":"Falha de autenticação da chave de API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Não encontra o template informado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /api/v3/chat\_insights

> Gerar insights imediatos de chat (legado)

```json
{"openapi":"3.0.3","info":{"title":"Genier API v3","version":"3.12.0"},"tags":[{"name":"Insights","description":"Gera análises, resumos e relatórios de conversas."}],"servers":[{"url":"https://{host}/{tenant}","description":"Define o host e o tenant usados nas chamadas.","variables":{"host":{"default":"app.genier.ai"},"tenant":{"default":"my-tenant"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ChatInsightsRequest":{"type":"object","required":["user_instructions","history"],"properties":{"user_instructions":{"type":"string","description":"Instruções para orientar a análise do LLM"},"history":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}}}},"ChatMessage":{"type":"object","properties":{"input":{"type":"string","description":"Texto enviado pelo usuário"},"output":{"type":"string","description":"Resposta do bot/atendente"}}},"ChatInsightsResponse":{"type":"object","properties":{"response":{"type":"object","properties":{"resumo":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"sentimental":{"type":"object","properties":{"sentimento":{"type":"string","description":"Positivo, Negativo ou Neutro"}}}}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v3/chat_insights":{"post":{"summary":"Gerar insights imediatos de chat (legado)","tags":["Insights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInsightsRequest"}}}},"responses":{"200":{"description":"Retorna os insights gerados pelo LLM.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInsightsResponse"}}}},"400":{"description":"Rejeita quando o corpo é inválido ou faltam campos obrigatórios.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Falha de autenticação da chave de API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /api/v3/reports/insights

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

```json
{"openapi":"3.0.3","info":{"title":"Genier API v3","version":"3.12.0"},"tags":[{"name":"Insights","description":"Gera análises, resumos e relatórios de conversas."}],"servers":[{"url":"https://{host}/{tenant}","description":"Define o host e o tenant usados nas chamadas.","variables":{"host":{"default":"app.genier.ai"},"tenant":{"default":"my-tenant"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"InsightsReportResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InsightsReportItem"}},"pagination":{"type":"object","properties":{"current_page":{"type":"integer"},"items_per_page":{"type":"integer"},"total_items":{"type":"integer"},"total_pages":{"type":"integer"}}},"filters":{"type":"object","properties":{"order_by":{"type":"string"},"order_direction":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tags_match":{"type":"string"},"search_filter":{"type":"string"},"agent_id":{"type":"string","nullable":true},"date_filter":{"type":"object","properties":{"date_type":{"type":"string","nullable":true},"relative_days":{"type":"integer","nullable":true},"start_datetime":{"type":"string","format":"date-time","nullable":true},"end_datetime":{"type":"string","format":"date-time","nullable":true},"applied":{"type":"boolean"}}}}}}},"InsightsReportItem":{"type":"object","properties":{"id":{"type":"integer"},"agent_id":{"type":"string"},"curator_id":{"type":"string"},"agent_name":{"type":"string"},"m_like":{"type":"integer","description":"Avaliação do usuário (1, 0 ou null)","nullable":true},"completed":{"type":"integer"},"insights":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"score":{"type":"number","format":"float"},"response_time":{"type":"number"},"interaction_count":{"type":"integer"},"message_count":{"type":"integer"},"workflow_name":{"type":"string"},"platform":{"type":"string"},"initial_time":{"type":"string","format":"date-time"},"final_time":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"string"}},"history":{"type":"array","items":{"type":"object"},"description":"Incluído somente quando download=true"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}},"InsightsReportErrorResponse":{"type":"object","properties":{"error":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/InsightsReportItem"}},"pagination":{"type":"object","properties":{"current_page":{"type":"integer"},"items_per_page":{"type":"integer"},"total_items":{"type":"integer"},"total_pages":{"type":"integer"}}}}}}},"paths":{"/api/v3/reports/insights":{"get":{"summary":"Consultar relatórios de insights com filtros e paginação","tags":["Insights"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1},"description":"Define o número da página, iniciando em 1."},{"name":"items_per_page","in":"query","required":false,"schema":{"type":"integer","default":5},"description":"Define a quantidade de itens por página (máximo 100)."},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","enum":["created_at","score","m_like","completed","agent_name"],"default":"created_at"},"description":"Define o campo usado para ordenar os resultados."},{"name":"order_direction","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Define a direção da ordenação."},{"name":"tags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"description":"Filtra resultados pelas tags informadas (aceita múltiplas entradas)."},{"name":"tags_match","in":"query","required":false,"schema":{"type":"string","enum":["all","any"],"default":"all"},"description":"Define como as tags devem corresponder (all exige todas, any aceita qualquer uma)."},{"name":"search_filter","in":"query","required":false,"schema":{"type":"string"},"description":"Aplica filtro textual aos campos indexados."},{"name":"agent_id","in":"query","required":false,"schema":{"type":"string"},"description":"Filtra pelo ID do agente."},{"name":"date_type","in":"query","required":false,"schema":{"type":"string","enum":["relative","absolute"]},"description":"Define o tipo de filtro de data."},{"name":"relative_days","in":"query","required":false,"schema":{"type":"integer"},"description":"Define a quantidade de dias para filtro relativo."},{"name":"start_datetime","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Define a data/hora inicial para filtro absoluto (ISO 8601)."},{"name":"end_datetime","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Define a data/hora final para filtro absoluto (ISO 8601)."},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Inclui o histórico completo quando definido como true."}],"responses":{"200":{"description":"Retorna lista paginada de curadorias e metadados dos filtros aplicados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsReportResponse"}}}},"401":{"description":"Falha de autenticação da chave de API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Falha interna ao recuperar os insights.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsReportErrorResponse"}}}}}}}}}
```

## POST /api/v3/go\_curator

> Executar curadoria de conversa

```json
{"openapi":"3.0.3","info":{"title":"Genier API v3","version":"3.12.0"},"tags":[{"name":"Insights","description":"Gera análises, resumos e relatórios de conversas."}],"servers":[{"url":"https://{host}/{tenant}","description":"Define o host e o tenant usados nas chamadas.","variables":{"host":{"default":"app.genier.ai"},"tenant":{"default":"my-tenant"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"GoCuratorRequest":{"type":"object","required":["agent_id","history","workflow_name","platform","initial_time","final_time"],"properties":{"agent_id":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/components/schemas/HistoryItem"}},"workflow_name":{"type":"string"},"platform":{"type":"string"},"initial_time":{"type":"string"},"final_time":{"type":"string"}}},"HistoryItem":{"type":"object","properties":{"input":{"type":"string"},"output":{"type":"string"},"role":{"type":"string","description":"Papel opcional no diálogo"}}},"GoCuratorResponse":{"type":"object","properties":{"message":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v3/go_curator":{"post":{"summary":"Executar curadoria de conversa","tags":["Insights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoCuratorRequest"}}}},"responses":{"200":{"description":"Retorna o resultado da curadoria executada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoCuratorResponse"}}}},"400":{"description":"Rejeita quando faltam parâmetros obrigatórios.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Falha de autenticação da chave de API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Falha interna ao processar a curadoria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fortics.com.br/ai-api-reference/reference/insights.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.