# Search knowledge

URL: https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-search

> Runs a hybrid search over the caller org's own knowledge — its wiki pages, its agent memories and everything its connectors have synced.

`POST /v1/knowledge/search`

> [Knowledge →](https://docs.hanzo.ai/docs/openapi/knowledge) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                            |
| ------------- | ------------------------------------------ |
| **Address**   | `https://api.hanzo.ai/v1/knowledge/search` |
| **Method**    | `POST`                                     |
| **Operation** | `post_knowledge_search`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`     |

Runs a hybrid search over the caller org's own knowledge —
its wiki pages, its agent memories and everything its connectors have synced.
This is the RAG entry point: an agent asks "what does this org know about X"
and the org's OWN knowledge answers. Two legs run and are fused by reciprocal
rank: a semantic leg that embeds the query and compares it with every passage
of every document in reach (a document is cut into passages of about 2000
bytes, so a fact deep in a long page is found), and a keyword leg over the
org's knowledge index. The org comes from the validated principal and its
passages live in its own database, so cross-tenant retrieval is impossible. A
failed leg answers 200 with what the other leg found and degraded=true, never
a 5xx.

## Request

4 fields, body `application/json` (required).

| Field      | In   | Type            | Required | Description                                                                                                 |
| ---------- | ---- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| `doctypes` | body | string\[]       | —        | DocTypes restricts retrieval to a subset of the indexed knowledge doctypes (kb.page, kb.memory, kb.source). |
| `limit`    | body | integer (int64) | —        | Limit bounds the hits returned.                                                                             |
| `project`  | body | string          | —        | Project narrows retrieval to one project scope.                                                             |
| `query`    | body | string          | —        | Query is the natural-language question.                                                                     |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | knowledge.searchOut | ok      |
| `default` | problem-details     | refused |

`200` body — 9 fields.

| Field             | In   | Type             | Always | Description                                                                                                                                                                                |
| ----------------- | ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `degraded`        | body | boolean          | —      | Degraded is true when a leg FAILED — the query could not be embedded, or a store could not be read — and Hits are what the other leg found, possibly nothing.                              |
| `hits`            | body | knowledge.hit\[] | —      | Hits are the matching documents, most relevant first: the order is the two legs fused, so a document both the semantic and the keyword leg found comes before one only a single leg found. |
| `hits[].doctype`  | body | string           | —      | DocType is which kind of knowledge matched, by address: kb.page (a wiki page), kb.memory (a unit of agent memory) or kb.source (a document a connector ingested).                          |
| `hits[].name`     | body | string           | —      | Name is the document's name in the framework store — the id to read or open it with.                                                                                                       |
| `hits[].project`  | body | string           | —      | Project is the project scope the document was saved under.                                                                                                                                 |
| `hits[].provider` | body | string           | —      | Provider is the connector that ingested the document — github, slack, google or notion.                                                                                                    |
| `hits[].score`    | body | number (double)  | —      | Score is the cosine similarity between the query's embedding and the document's BEST-matching passage, from -1 to 1, higher being closer.                                                  |
| `hits[].title`    | body | string           | —      | Title is the document's title.                                                                                                                                                             |
| `hits[].url`      | body | string           | —      | URL is the document's link back into the app it was ingested from.                                                                                                                         |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo knowledge search
```

**SDK**

**.ts**

```ts
import { Configuration, KnowledgeApi } from 'hanzoai';

const api = new KnowledgeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postKnowledgeSearch({ doctypes: ["<doctypes>"], limit: 0 });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import KnowledgeApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = KnowledgeApi(client).post_knowledge_search(doctypes=["<doctypes>"], limit=0)
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.KnowledgeAPI.PostKnowledgeSearch(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, knowledge_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = knowledge_api::post_knowledge_search(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.KnowledgeApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new KnowledgeApi(client).postKnowledgeSearch();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/knowledge/search \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "doctypes": [
         "<doctypes>"
       ],
       "limit": 0
     }'
```

**MCP**

MCP reaches **knowledge** through the `knowledge` tool, which names its 9 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_knowledge_connectors"
         }
       }
     }'
```

---

[Knowledge API](https://docs.hanzo.ai/docs/openapi/knowledge) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)