Skip to navigation
API ReferenceKnowledge Base

List knowledge entries

Newest first.

Requires the knowledge:read API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Query parameters

categoryenumOptional
Allowed values:
statusenumOptional
Allowed values:
tagsstringOptional

Comma-separated tags. Matches entries carrying every listed tag.

Response

Matching entries.
idstringformat: "uuid"
titlestring
contentstring
categoryenum
Allowed values:
statusenum
Only active entries are given to agents.
Allowed values:
priorityenum

When agents get the entry; see Priority.

Allowed values:
sourceenum
Allowed values:
tagslist of strings
confidencestring or null
createdBystring or nullformat: "uuid"
createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error