---
title: "POST /ask"
method: POST
path: "/ask"
tags: ["Agent Discovery"]
---

# POST /ask

`POST /ask`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/ask`
- Auth: none required

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`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `502`: Documentation search is unavailable.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 6 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `500`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `default`
  - …2 more

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

---

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