---
title: "Search knowledge documents"
url: https://docs.gleap.ai/en/reference/rest-api/search-knowledge
method: POST
path: "/knowledge/search"
api: "API Reference"
tag: "Knowledge"
operationId: "SearchKnowledge"
updatedAt: "2026-11-01T18:40:15.677Z"
language: en
---

# Search knowledge documents

`POST https://api.gleap.io/v3/knowledge/search`

Search through knowledge base documents using vector search and reranking. Returns matching documents from help-center articles, FAQs/snippets, websites, news, YouTube videos, and code knowledge. `limit` caps the number of returned documents; retrieval returns at most 10 documents regardless of a higher limit.

## Authorization

- `Authorization` (header, required): `Bearer <token>`

## Headers

- `project` (string, required)

## Request body (`application/json`, required)

- `query` (string, required)
- `documentTypeFilter` (string)
- `internally` (boolean)
- `lang` (string)
- `limit` (number<double>): Max documents to return. Values above 10 have no effect; retrieval is capped at 10.
- `scope` (object)
  - `tags` (string[])
  - `mode` (enum<string>, required): One of: `all`, `include`, `exclude`.

## Example request

```bash
curl --request POST \
  --url https://api.gleap.io/v3/knowledge/search \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<query>"
}'
```

## Responses

### 200 (`application/json`)

Ok

- `results` (object[], required)
  - `sourceId` (string, required)
  - `sourceType` (string, required)
  - `title` (string)
  - `content` (string, required)
  - `url` (string)
  - `relevanceScore` (number<double>): Rerank relevance (0-1); absent when the rerank was unavailable.
- `count` (number<double>, required)

```json
{
  "results": [
    {
      "sourceId": "string",
      "sourceType": "string",
      "title": "string",
      "content": "string",
      "url": "string",
      "relevanceScore": 0
    }
  ],
  "count": 0
}
```