---
title: "Chat"
method: POST
path: "/api/v1/nlq/chat"
tags: ["nlq"]
---

# Chat

`POST /api/v1/nlq/chat`

## Headers

- `authorization` string, nullable
- `X-API-Key` string, nullable

## Request body

- NLQChatRequest
  - `question` string, required
  - `history` ChatTurn[]
    - `role` string, required
    - `content` string, required
  - `current_filter_tree` object, nullable
  - `current_object_type` string, nullable
  - `conversation_id` integer, nullable

## Response `200`

Successful Response

- NLQChatResponse
  - `answer` string, required
  - `steps` AgentStep[], required
    - `tool` string, nullable
    - `tool_input` union
      - object
      - string
    - `observation` unknown
  - `object_type` string, nullable
  - `filter_tree` object, nullable
  - `preview` NLQPreview
    - `items` object[], required
    - `total` integer, required
    - `hidden_field_count` integer
    - `sort_field` string, nullable
    - `sort_dir` string, nullable
    - `limit` integer, nullable
    - `partition_by` string[], nullable
    - `n_per_group` integer, nullable
    - `total_groups` integer, nullable
  - `aggregate` NLQAggregate
    - `group_by` string[]
    - `aggregations` object[]
    - `columns` NLQAggregateColumn[], required
      - `name` string, required
      - `kind` string, required
      - `field` string, nullable
      - `function` string, nullable
    - `rows` object[], required
    - `total_groups` integer, required
    - `top` integer, required
  - `explanation` string, nullable
  - `error` string, nullable
  - `conversation_id` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ninjavan/apis/salesforce-sales-cloud-replacement.md) · [All operations](https://skmtc.net/ninjavan/apis/salesforce-sales-cloud-replacement/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjavan/salesforce-sales-cloud-replacement/versions/fd3a41a6260b/schema)