Skip to main content

This is a Custom Schema Page Generated by docusaurus-openapi-docs using schema.mustache template




KnowledgeResource

A resource in the knowledge base (file or URL)

idstringrequired

Resource ID

Example: 507f1f77bcf86cd799439022
typestringrequired

Type of resource

Possible values: [file, url]

Example: file
namestringrequired

Display name for the resource

Example: API Documentation
descriptionstring

Description of the resource

Example: Complete API documentation and examples
tagsstring[]

Tags associated with the resource

Example: ["documentation","api","guide"]
statusstringrequired

Resource status

Possible values: [active, inactive, archived]

Example: active
filenamestring

Stored filename on disk (only for file resources)

Example: file-1701234567890-123456789.pdf
filepathstring

Full path to the file on disk (only for file resources)

Example: /app/uploads/knowledge-base/file-1701234567890-123456789.pdf
sizeinteger

File size in bytes (only for file resources)

Example: 1048576
mimetypestring

MIME type of the file (only for file resources)

Example: application/pdf
urlstring<uri>

The URL of the resource (only for URL resources)

Example: https://docs.example.com/api-guide
uploadedAtstring<date-time>

Upload timestamp (only for file resources)

Example: 2023-12-01T10:30:00.000Z
addedAtstring<date-time>

When the URL was added (only for URL resources)

Example: 2023-12-01T10:30:00.000Z
updatedAtstring<date-time>

Last update timestamp

Example: 2023-12-01T15:45:00.000Z



This is a Custom Schema Page Generated by docusaurus-openapi-docs using schema.mustache template

KnowledgeResource
{
"id": "507f1f77bcf86cd799439022",
"type": "file",
"name": "API Documentation",
"description": "Complete API documentation and examples",
"tags": [
"documentation",
"api",
"guide"
],
"status": "active",
"filename": "file-1701234567890-123456789.pdf",
"filepath": "/app/uploads/knowledge-base/file-1701234567890-123456789.pdf",
"size": 1048576,
"mimetype": "application/pdf",
"url": "https://docs.example.com/api-guide",
"uploadedAt": "2023-12-01T10:30:00.000Z",
"addedAt": "2023-12-01T10:30:00.000Z",
"updatedAt": "2023-12-01T15:45:00.000Z"
}