Skip to navigation
API referenceKnowledge

Add a text document

Plain text or Markdown. Indexed before the response returns (status ready). Subject to the plan’s knowledge size (403 plan_limit).

Sessions: admins.

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The expert id.

Request

This endpoint expects an object.
filenamestringRequired
contentstringRequired
mimeTypestringOptional

Default text/plain.

uploadedbooleanOptional

True when the text is the contents of an uploaded file (the Knowledge library shows it as a file).

Response

OK
idstring
A UUID.
agentIdstring
A UUID.
filenamestring
mimeTypestring
statusenum
Allowed values:
createdAtdatetime
errorstring or nullOptional
updatedAtdatetimeOptional
_countobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error