> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinglog.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Leia /llms.txt antes de explorar páginas. A API HTTP usa Authorization: Bearer com o JWT da conta. A chave kl_live_ serve só ao assistente MCP e não substitui o JWT. Não invente rotas, hosts públicos, SDKs ou CLI. companyId e userId vêm da sessão. Consultas não aceitam SQL. Exclusão no assistente exige confirm=true. O webhook público é POST /webhook/leads.

# Consulta

> Lista e agregação sem SQL. Schema em `describe`, lista em `run`, agrupamento em `aggregate`. A permissão da conta vale igual.

Lista e agregação sem SQL. Schema em `describe`, lista em `run`, agrupamento em `aggregate`. A permissão da conta vale igual.

> [card] Obrigatório
>
> `entity` em `run`. Em `aggregate`, `entity` e `aggregate`.

## Fluxo

1. Chame `describe` para ver campos e operadores.
2. Use `run` para listar.
3. Use `aggregate` para contar e agrupar.

## Operações

| Você quer | Método | Caminho |
| - | - | - |
| [Descobrir schema consultável](https://docs.kinglog.com.br/pages/reference/ai-query/ai-query-describe.md) | `POST` | `/ai/query/describe` |
| [Consulta estruturada](https://docs.kinglog.com.br/pages/reference/ai-query/ai-query-run.md) | `POST` | `/ai/query/run` |
| [Agregação agrupada](https://docs.kinglog.com.br/pages/reference/ai-query/ai-query-aggregate.md) | `POST` | `/ai/query/aggregate` |

## Exemplo de requisição

```json theme={null}
{
  "entity": "tasks",
  "query": {
    "fields": [
      "id",
      "title"
    ],
    "pagination": {
      "limit": 20
    }
  }
}
```

## Exemplo de resposta

```json theme={null}
{
  "success": true,
  "data": {
    "rows": [
      {
        "id": 1,
        "title": "Tarefa de exemplo"
      }
    ]
  },
  "code": "SUCCESS"
}
```

> [!TIP]
>
> Em campo de usuário, `@me` é a pessoa do JWT.

> [!TIP]
>
> Não envie SQL. Use o schema de `ai.query.describe`.

## Relacionado

* [Guia: consultar dados](https://docs.kinglog.com.br/pages/guides/consultar-dados.md)
* [Guia: calcular uma métrica](https://docs.kinglog.com.br/pages/guides/calcular-metrica.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.