Error
A valid request URL is required to generate request examples{
"total_matches": 137,
"truncated": true,
"query": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "<string>",
"path": "<string>",
"title": "<string>",
"entry_type": "<string>",
"tags": [
"<string>"
],
"score": 123,
"headline": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"count": 123,
"search_type": "fts",
"score_type": "ts_rank"
}API Reference
Search knowledge entries
Full-text search across knowledge entries. Without agent_id, searches across all owned agents (or all agents for admins). With agent_id, searches only that agent’s entries (ownership enforced for users).
GET
/
knowledge
/
search
Error
A valid request URL is required to generate request examples{
"total_matches": 137,
"truncated": true,
"query": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "<string>",
"path": "<string>",
"title": "<string>",
"entry_type": "<string>",
"tags": [
"<string>"
],
"score": 123,
"headline": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"count": 123,
"search_type": "fts",
"score_type": "ts_rank"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Search query
Minimum string length:
1Optional agent ID to scope search
Response
Search results
How many entries MATCHED. results is capped (20), so this differs
from count exactly when the page was cut. Reporting the page length
as the match count is the defect issues #180/#188/#197 were each about.
Example:
137
True when total_matches exceeds the number of results returned.
Show child attributes
Show child attributes
Example:
"fts"
Example:
"ts_rank"