> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.rydhm.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.rydhm.ai/_mcp/server.

# Search the knowledge

GET https://api.rydhm.ai/v1/agents/{id}/kb/search

Needs the knowledge:read scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Reference: https://docs.rydhm.ai/api-reference/knowledge/search

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `id` (string, required) — The expert id.

### Query parameters

- `q` (string, required) — The question or words to look for.
- `mode` (enum, optional) — hybrid (default) or vector.
  - Allowed values: `hybrid`, `vector`
- `rerank` (string, optional) — 1 to rerank the hits with a model.

## Response

### 200

OK

- `list of KnowledgeHit`

## Errors

### 401 Unauthorized Error

The key is missing, not valid, disabled or expired (error: invalid_api_key, api_key_disabled, api_key_expired).

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

### 403 Forbidden Error

The key lacks a scope (insufficient_scope), may not use this expert (expert_not_allowed), or the route is session-only (not_available_to_api_keys).

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

### 429 Too Many Requests Error

Rate limited; wait Retry-After seconds.

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

## Types

### KnowledgeHit

- `id` (string, required) — A UUID.
- `text` (string, required)
- `score` (double, required) — Cosine similarity, 0–1.
- `relevance` (double, optional) — The fused rank score the hits are ordered by; higher is better.
- `matched` (list of enum, optional)
  - Allowed values: `vector`, `keyword`, `faq`
- `source` (KnowledgeHitSource, optional) — The document the passage came from.

### ErrorUpgradeHint

On 402 payment_required and 403 plan_limit: what fixes it.

- `action` (enum, optional)
  - Allowed values: `top_up`, `upgrade`, `contact`
- `planCode` (string, optional) — The smallest plan that allows it, when action is upgrade.
- `href` (string, optional) — Where to go in the app.

### KnowledgeHitSource

The document the passage came from.

- `documentId` (string, required) — A UUID.
- `filename` (string, required) — A filename, an FAQ title or a page title.
- `kind` (enum, required)
  - Allowed values: `text`, `faq`, `page`
- `ord` (integer, required) — Position of the passage within its document (0-based).
- `sourceUrl` (string, optional, nullable)
- `question` (string, optional, nullable)

## Examples

**Response**

```json
[
  {
    "id": "string",
    "text": "string",
    "score": 1.1,
    "relevance": 1.1,
    "matched": [
      "vector"
    ],
    "source": {
      "documentId": "string",
      "filename": "string",
      "kind": "text",
      "ord": 1,
      "sourceUrl": "string",
      "question": "string"
    }
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.rydhm.ai/v1/agents/id/kb/search"

querystring = {"q":"q"}

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.rydhm.ai/v1/agents/id/kb/search?q=q';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```