---
title: "Full-text search across the entire Windmill documentation. Provide one or more keywords; returns the most relevant docs pages, each with its Source URL and short matching snippets. Use this FIRST to find relevant pages by their content (a flag, function, error message, config key or concept). If the snippets answer the question, answer directly; otherwise call readDocsPage with a returned Source URL to read more."
method: GET
path: "/docs/search"
tags: ["documentation"]
---

# Full-text search across the entire Windmill documentation. Provide one or more keywords; returns the most relevant docs pages, each with its Source URL and short matching snippets. Use this FIRST to find relevant pages by their content (a flag, function, error message, config key or concept). If the snippets answer the question, answer directly; otherwise call readDocsPage with a returned Source URL to read more.

`GET /docs/search`

## Query parameters

- `query` string, required

## Response `200`

matching documentation pages

- object
  - `text` string, required — Model-ready rendering of the results
  - `results` object[], required
    - `url` string, required
    - `title` string, required
    - `score` integer, required
    - `snippets` string[], required

## Changes

- **2026-06-25** `8fd2617ee2c2` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/windmill/apis/windmill-api/changes/docs/search/get.md)

---

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