Toolzz AI
- Introduction
- Planos
- ChatService
- Auth
- Institution
- Unity
- Bot
- Widget
- GenAI
- Fallback
- Member
- Function
- Credential
- KnowledgeBase
- Voice
- Audio
- Toolzz Analytics
- Kratos
Get KnowledgeBase by Unity
Endpoint to get all KnowledgeBase from Unity
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/knowledge/unity/{id} \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"unityId": "<string>",
"kbCreatorId": "<string>",
"kbInstitutionId": "<string>",
"kbStatus": 123,
"kbName": "<string>",
"kbDescription": "<string>",
"kbIconImg": "<string>",
"kbFolder": [
{
"id": "<string>",
"name": "<string>",
"knowLedgeBaseId": "<string>",
"isRoot": true,
"institutionId": "<string>",
"knowLedgeBaseFile": [
{
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"institutionId": "<string>",
"fileName": "<string>",
"internalStorageUrl": "<string>",
"url": "<string>",
"size": 123,
"extension": "<string>",
"maskName": "<string>",
"integrationId": "<string>",
"customData": [
{}
]
}
],
"_count": {
"knowLedgeBaseFile": 123
}
}
],
"documentsInfo": {
"size": 123,
"documentCount": 123
},
"isActivated": true
}
],
"knowledgeBaseCount": 123,
"activeCount": 123,
"knowledgeBaseLimit": 123
}
Body Description
The Unity ID
Response Description
The endpoint returns a response in JSON format with a confirmation response to the request.
List of knowledge bases.
Unique identifier of the knowledge base.
Identifier of the associated unity.
ID of the creator of the knowledge base.
Identifier of the institution owning the knowledge base.
Status of the knowledge base (e.g., 1 for active).
Name of the knowledge base.
Description of the knowledge base.
URL of the knowledge base icon.
List of folders within the knowledge base.
Unique identifier of the folder.
Name of the folder.
ID of the associated knowledge base.
Indicates if the folder is a root folder.
ID of the institution owning the folder.
List of files in the folder.
Unique identifier of the file.
Timestamp when the file was created.
Timestamp when the file was last updated.
ID of the institution owning the file.
Name of the file.
Internal storage URL of the file.
Public URL of the file.
Size of the file in bytes.
File extension.
Mask name of the file.
ID of the integration associated with the file (if any).
Custom metadata associated with the file.
Indicates if the knowledge base is activated.
Total number of knowledge bases.
Number of active knowledge bases.
Maximum allowed knowledge bases.
Segurança
Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.
Code Response
Exemples of security error
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/knowledge/unity/{id} \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"unityId": "<string>",
"kbCreatorId": "<string>",
"kbInstitutionId": "<string>",
"kbStatus": 123,
"kbName": "<string>",
"kbDescription": "<string>",
"kbIconImg": "<string>",
"kbFolder": [
{
"id": "<string>",
"name": "<string>",
"knowLedgeBaseId": "<string>",
"isRoot": true,
"institutionId": "<string>",
"knowLedgeBaseFile": [
{
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"institutionId": "<string>",
"fileName": "<string>",
"internalStorageUrl": "<string>",
"url": "<string>",
"size": 123,
"extension": "<string>",
"maskName": "<string>",
"integrationId": "<string>",
"customData": [
{}
]
}
],
"_count": {
"knowLedgeBaseFile": 123
}
}
],
"documentsInfo": {
"size": 123,
"documentCount": 123
},
"isActivated": true
}
],
"knowledgeBaseCount": 123,
"activeCount": 123,
"knowledgeBaseLimit": 123
}