VAvanta
Knowledge Base

Create document resource

Create a document (FILE-type) resource in the Trust Knowledge Base. Accepts the document as a multipart/form-data upload.

Example: send multipart/form-data with a required file (e.g. PDF) and title; optional fields include description, customerVisibility, downloadPermission, isUsedInQuestionnaires ("true"/"false"), expirationDate (ISO 8601), tags (JSON array string), categoryId, and ownerAssignment (JSON object string).

post/knowledge-base/resources/documents

Request

Request body multipart/form-data

filestring binary required
titlestring required

Title of the document resource.

descriptionstring

Description of the document resource.

ownerAssignmentstring

Owner to assign as a JSON string: {"type":"User","id":"<id>"}.

customerVisibilitystring

Customer visibility on the Trust Center: PRIVATE | SHAREABLE | REQUEST_ACCESS | PUBLIC.

downloadPermissionstring

Trust Center download permission: VIEW_ONLY | VIEW_AND_DOWNLOAD.

isUsedInQuestionnairesstring

Whether to use this resource for Questionnaire Automation answer generation ("true" / "false").

expirationDatestring

Expiration date in ISO 8601.

tagsstring

Tags as a JSON array: [{"categoryId":"<id>","tagId":"<id>"}].

categoryIdstring

Trust Center category id to associate this resource with. Only applied when customerVisibility is REQUEST_ACCESS or PUBLIC; other visibilities don't place the resource on the Trust Center, so the category is ignored. Pass an unknown id to fall back to uncategorized.

Response

Ok

idstring required
type'FILE' required
titlestring required
descriptionstring nullable required
fileUrlstring required

Presigned S3 URL for the underlying document. Expires after 1 hour due to AWS IAM Role limitations on presigned URL lifetimes. Re-fetch the resource to obtain a fresh URL once this one expires.

customerVisibility'PRIVATE' | 'SHAREABLE' | 'REQUEST_ACCESS' | 'PUBLIC' | 'null' nullable required
downloadPermission'VIEW_ONLY' | 'VIEW_AND_DOWNLOAD' | 'null' nullable required
isUsedInQuestionnairesboolean nullable required
expirationStatus'CURRENT' | 'EXPIRED' required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

expirationDatestring nullable required
lastUpdatedstring required
lastVerifiedstring nullable required
categoryIdstring nullable required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).

Changes

No recorded changes to this operation across all 1 revision of this API.