---
title: "Search Xquik documentation with query parameters"
method: GET
path: "/ask"
tags: ["Agent Discovery"]
---

# Search Xquik documentation with query parameters

`GET /ask`

Send a flat NLWeb 0.55 request through query parameters.

## Query parameters

- `query` string, required
- `site` 'docs.xquik.com' | 'xquik.com'
- `mode` 'list'
- `response_format` 'chatgpt_app' | 'conversational_search'
- `streaming` boolean

## Response `200`

Documentation results.

- union — NLWeb documentation answer in a supported response format.
  - object
    - `_meta` object, required — NLWeb response metadata.
      - `response_type` 'answer', required
      - `response_format` 'chatgpt_app' | 'conversational_search'
      - `version` '0.55', required
    - `results` NlwebDocumentationResult[], required
      - `@context` 'https://schema.org', required
      - `@id` string, uri, required
      - `@type` 'TechArticle', required
      - `description` string, required
      - `name` string, required
      - `url` string, uri, required
    - `content` object[]
      - `text` string, required
      - `type` 'text', required
    - `structuredData` NlwebDocumentationResult[]
      - `@context` 'https://schema.org', required
      - `@id` string, uri, required
      - `@type` 'TechArticle', required
      - `description` string, required
      - `name` string, required
      - `url` string, uri, required
  - object
    - `_meta` object, required — NLWeb response metadata.
      - `response_type` 'answer', required
      - `response_format` 'chatgpt_app' | 'conversational_search'
      - `version` '0.55', required
    - `results` NlwebDocumentationResult[]
      - `@context` 'https://schema.org', required
      - `@id` string, uri, required
      - `@type` 'TechArticle', required
      - `description` string, required
      - `name` string, required
      - `url` string, uri, required
    - `content` object[], required
      - `text` string, required
      - `type` 'text', required
    - `structuredData` NlwebDocumentationResult[], required
      - `@context` 'https://schema.org', required
      - `@id` string, uri, required
      - `@type` 'TechArticle', required
      - `description` string, required
      - `name` string, required
      - `url` string, uri, required

## Other responses

- `400` — Invalid or unsupported NLWeb request.
- `413` — Request body exceeds 8 KiB.
- `502` — Documentation search is unavailable.

## Changes

- **2026-08-28** `a46c465a7ef1` — 7 breaking, 8 warning, 12 info
  - for the `query` request parameter `response_format`, default value `conversational_search` was added
  - for the `query` request parameter `streaming`, default value was changed from `true` to `false`
  - removed the enum value `conv_search` from the `query` request parameter `response_format`
  - the `response_type` response property const value changed from `Answer` to `answer` for the status `200`
  - …23 more
- **2026-08-27** `a025a07f7718` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/xquik-dev/apis/xquik-api-3/changes/ask/get.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api-3.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xquik-dev/xquik-api-3/revisions/3e010a962d32/schema)