Retrieve Knowledge File

curl --request GET \
  --url https://api.bey.dev/v1/knowledge-files/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "name": "<string>",
  "status": "to-upload"
}

GET

knowledge-files

{id}

Retrieve Knowledge File

curl --request GET \
  --url https://api.bey.dev/v1/knowledge-files/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "name": "<string>",
  "status": "to-upload"
}

x-api-key

string

header

required

Your Beyond Presence API Key.

string

required

Knowledge File ID.

Requested Knowledge File

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

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"