---
title: "Search Xquik documentation with NLWeb"
method: POST
path: "/ask"
tags: ["Agent Discovery"]
---

# Search Xquik documentation with NLWeb

`POST /ask`

Search public Xquik docs with NLWeb 0.55. This read-only route accepts flat and structured requests. Never send secrets or private data.

## Request body

- NlwebAskRequest — Public NLWeb documentation search request.
  - `query` union, required
    - string — Natural-language documentation query.
    - object
      - `text` string, required
      - `site` 'docs.xquik.com' | 'xquik.com'
  - `site` 'docs.xquik.com' | 'xquik.com'
  - `streaming` boolean
  - `response_format` 'chatgpt_app' | 'conversational_search'
  - `mode` 'list'
  - `context` object — Optional NLWeb conversational context.
  - `prefer` object
    - `streaming` boolean
    - `response_format` 'chatgpt_app' | 'conversational_search'
    - `mode` 'list'
  - `meta` object
    - `api_version` '0.54' | '0.55'
    - `version` '0.54' | '0.55'

## 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.
- `429` — Xquik tier rate limit exceeded. The response includes a `Retry-After` header with the number of seconds to wait before retrying.
- `502` — Documentation search is unavailable.
- `default` — Unexpected error.

## Changes

- **2026-08-28** `f23b15f4dac2` — 8 breaking, 8 warning, 16 info
  - removed the enum value `conv_search` of the request property `prefer/response_format` (media type: application/json)
  - removed the enum value `conv_search` of the request property `prefer/response_format` (media type: application/x-www-form-urlencoded)
  - removed the enum value `conv_search` of the request property `response_format` (media type: application/json)
  - removed the enum value `conv_search` of the request property `response_format` (media type: application/x-www-form-urlencoded)
  - …28 more
- **2026-08-27** `8145a5bd0555` — 1 info
  - endpoint added

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

---

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