Retrieve Knowledge File
curl --request GET \
--url https://api.bey.dev/v1/knowledge-files/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/knowledge-files/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bey.dev/v1/knowledge-files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "Hitchhiker's Guide to the Galaxy",
"format": "text",
"status": "to-upload"
}Agent Knowledge Files
Retrieve Knowledge File
Retrieve a single knowledge file by ID, including its extracted text.
GET
/
v1
/
knowledge-files
/
{id}
Retrieve Knowledge File
curl --request GET \
--url https://api.bey.dev/v1/knowledge-files/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/knowledge-files/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bey.dev/v1/knowledge-files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "Hitchhiker's Guide to the Galaxy",
"format": "text",
"status": "to-upload"
}Authorizations
Your Beyond Presence API Key.
Path Parameters
Knowledge File ID.
Response
Requested Knowledge File
- ToUploadKnowledgeFileResponse
- AvailableKnowledgeFileResponse
Response model for a knowledge file that is to be uploaded.
Unique identifier of the object in the database.
Example:
"01234567-89ab-cdef-0123-456789abcdef"
Required string length:
1 - 100Example:
"Hitchhiker's Guide to the Galaxy"
Format of the knowledge file.
Available options:
text, pdf Allowed value:
"to-upload"Was this page helpful?