---
title: "NLWeb ask, list mode: the General articles matching a query, in NLWeb's list shape"
method: GET
path: "/ask"
---

# NLWeb ask, list mode: the General articles matching a query, in NLWeb's list shape

`GET /ask`

## Request

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

No model is called: generate_mode summarize or generate is answered as a list, and _meta.note says so. streaming=true, or Accept: text/event-stream, sends the same list as server-sent events (one result_batch, then complete). Also at https://www.edgechat.ai/ask; POST takes the same fields as a JSON body.

## Query parameters

- `query` string, required
- `decontextualized_query` string
- `num_results` integer
- `generate_mode` 'list' | 'summarize' | 'generate'
- `mode` string
- `streaming` 'true' | 'false'
- `query_id` string
- `site` string
- `prev` string
- `last_ans` string
- `item_to_remember` string
- `fields` string

## Response `200`

The matching articles, best first

- NlwebAskResponse
  - `_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)