Knowledge Base

Add Knowledge Base Text Document

Add a Text Document

Requires the OWNER or ADMIN role. Adds a document with text you supply directly -- the only way this endpoint set creates a document (uploading a file or crawling a website use endpoints not covered here). Kicks off embedding immediately; status starts at uploaded and moves toward ready on its own.

post/knowledge-bases/{kbId}/documents/manual

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/knowledge-bases/{kbId}/documents/manual
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

kbIdstring required

The collection's knowledgeBaseId.

Request body

titlestring required

Up to 200 characters. Required.

textstring required

Required, non-empty. Size-capped server-side; an oversized submission is a 400 asking you to split it into smaller entries.

Response

Created

status'success'

Changes

No recorded changes to this operation across all 2 revisions of this API.