Skip to navigation
API referenceKnowledgeCollections

Add a text document to a collection

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

cidstringRequired
The collection id.

Request

This endpoint expects an object.
filenamestringRequired
contentstringRequired
mimeTypestringOptional
uploadedbooleanOptional
True when the text is the contents of an uploaded 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