---
title: "NLWeb ask, list mode, with the parameters in a JSON or form body"
method: POST
path: "/ask"
---

# NLWeb ask, list mode, with the parameters in a JSON or form body

`POST /ask`

## Request

- Base URL: `https://www.edgechat.ai/api/v1`
- URL: `https://www.edgechat.ai/api/v1/ask`
- Auth: none declared

## Request body

- object
  - `query` string, required: A subject's name or words from its title.
  - `decontextualized_query` string: Used in place of query when given.
  - `num_results` integer
  - `generate_mode` 'list' | 'summarize' | 'generate'
  - `mode` string: An older name for generate_mode.
  - `streaming` 'true' | 'false'
  - `query_id` string: Echoed back; a new one is made when absent.
  - `site` string: Accepted and ignored: this site holds one collection.
  - `prev` string: Accepted and ignored.
  - `last_ans` string: Accepted and ignored.
  - `item_to_remember` string: Accepted and ignored.

## Response `200`

The matching articles, best first

- NlwebAskPostResponse
  - `_meta` object
    - `version` string
    - `response_type` 'list'
    - `generate_mode` string
    - `note` string
  - `query_id` string
  - `query` string
  - `did_you_mean` string
  - `results` object[]
    - `url` string, uri
    - `name` string
    - `site` string
    - `score` number
    - `description` string
    - `schema_object` object
  - `license` License
    - `name` string, required
    - `url` string, uri, required
    - `summary` string
    - `spdx` string

## Other responses

- `400`: An error: a missing query, or `unknown_parameter` for a parameter this route does not read.
- `429`: An error
- `503`: Briefly unavailable; try again

---

[API](https://skmtc.dev/edgechat/apis/edgepedia-api.md) · [All operations](https://skmtc.dev/edgechat/apis/edgepedia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/edgechat/apis/edgepedia-api/revisions/cd4eb5972d56?raw)