Skip to main content
GET
/
api
/
v1
/
knowledge
List knowledge documents
curl --request GET \
  --url http://localhost:3001/api/v1/knowledge \
  --cookie nut-session=
{
  "success": true,
  "data": {},
  "query": "<string>",
  "full": true,
  "totalCount": 123,
  "count": 123,
  "limit": 123,
  "offset": 123,
  "documents": [
    {
      "filename": "<string>",
      "title": "<string>",
      "content": "<string>",
      "metadata": {
        "updated": "2023-11-07T05:31:56Z",
        "category": "<string>",
        "tags": [
          "<string>"
        ],
        "sources": [
          "<string>"
        ],
        "summary": "<string>"
      },
      "snippet": "<string>",
      "matchedIn": [
        "<string>"
      ],
      "score": 123
    }
  ]
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Query Parameters

q
string

Fuzzy search across title, content, tags, category, and summary. Results are ranked by relevance.

limit
integer

Maximum number of results per page (1-100)

Required range: 1 <= x <= 100
offset
integer
default:0

Number of results to skip for pagination (default 0)

Required range: x >= 0
full
enum<string>
default:false

Set to "true" to include full markdown content instead of summaries

Available options:
true,
false

Response

List of knowledge documents

success
boolean
required
data
object
query
string

Echo of the search query (only present when q is provided)

full
boolean

Whether full content is included

totalCount
integer

Total number of matching documents (before pagination)

count
integer

Number of documents in this response page

limit
integer

Page size (only present when limit is specified)

offset
integer

Number of results skipped

documents
object[]