---
title: "Search documentation"
method: POST
path: "/v2/documentation/search"
tags: ["Documentation"]
---

# Search documentation

`POST /v2/documentation/search`

Searches the orq.ai documentation index for the given query and returns the matching pages with content snippets and metadata.

## Request body

- SearchDocumentationRequest
  - `query` string, required — Free-text query to search the documentation for.
  - `limit` integer — Maximum number of results to return (1-50). Defaults to 10.
  - `score_threshold` number, double — Minimum relevance score (0-1). Defaults to 0.6.

## Response `200`

OK

- SearchDocumentationResponse
  - `results` DocumentationSearchResult[], required — Documentation pages matching the query, ordered by relevance.
    - `content` string, required — Matching content snippet from the documentation page.
    - `path` string, required — Path of the documentation page within the docs site.
    - `metadata` DocumentationSearchResultMetadata, required
      - `title` string, required — Page title.
      - `description` string, required — Short page description.
      - `href` string, required — Absolute URL to the documentation page.
      - `icon` string — Optional icon identifier for the page.

---

[API](https://skmtc.net/orq-ai/apis/orq-ai-api.md) · [All operations](https://skmtc.net/orq-ai/apis/orq-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orq-ai/orq-ai-api/versions/6a22c53a2580/schema)