Skip to main content
POST
Create Knowledge File

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

Request model for creating a text knowledge file.

name
string
required
Required string length: 1 - 100
Example:

"Hitchhiker's Guide to the Galaxy"

format
string
required
Allowed value: "text"
content
string
required
Required string length: 1 - 100000

Response

Created Knowledge File

Response model for a knowledge file that is to be uploaded.

id
string
required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

name
string
required
Required string length: 1 - 100
Example:

"Hitchhiker's Guide to the Galaxy"

format
enum<string>
required

Format of the knowledge file.

Available options:
text,
pdf
status
string
default:to-upload
Allowed value: "to-upload"