---
title: "Search c15t documentation"
method: GET
path: "/ask"
tags: ["Documentation"]
---

# Search c15t documentation

`GET /ask`

## Request

- Base URL: `https://c15t.com`
- URL: `https://c15t.com/ask`
- Auth: none required
- TypeScript: <https://skmtc.dev/c15t/apis/c15t-agent-api/docs/ask/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns ranked c15t documentation pages for a natural-language query. Set streaming to true to receive server-sent events instead of one JSON document.

## Query parameters

- `query` string, required
- `query_id` string
- `streaming` boolean

## Response `200`

Ranked documentation results.

- NlwebAnswer
  - `query_id` string, required
  - `_meta` NlwebAnswerMeta, required
    - `response_type` 'answer', required
    - `version` '0.55', required
    - `streaming` boolean
  - `results` NlwebResult[], required
    - `url` string, uri, required
    - `name` string, required
    - `site` string, required
    - `score` number, required
    - `description` string, required
    - `schema_object` object, required: Schema.org TechArticle metadata for the result.

## Other responses

- `400`: The query is missing or empty.
- `500`: The documentation index could not answer the query.

---

[API](https://skmtc.dev/c15t/apis/c15t-agent-api.md) - [All operations](https://skmtc.dev/c15t/apis/c15t-agent-api/llms.txt) - [OpenAPI document](https://skmtc.dev/c15t/apis/c15t-agent-api/revisions/b599f61ee936?raw)