Skip to navigation
API ReferenceKnowledge Base

Create a knowledge entry

Requires a user credential: a workspace API key has no author to attribute the change to and receives 403. An always entry also requires a workspace admin or owner. A create past the workspace’s Always limit returns 400.

Requires the knowledge:write 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.

Request

This endpoint expects an object.
titlestringRequired
contentstringRequired
categoryenumRequired
Allowed values:
priorityenumOptional

Defaults to on_request.

Allowed values:
tagslist of stringsOptional

Response

The created entry.
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