Skip to main content
BlueAI
Home/Documents/Overview

Documents Reference

Document management domain API for creating, sharing, and versioning documents

|
Folders

Create, update, list, and delete folders for organizing documents. Folders can be nested by specifying a parent_id to create hierarchical structures.

  • GET/api/v1/docs/folders— List folders
  • POST/api/v1/docs/folders— Create a folder
  • GET/api/v1/docs/folders/{id}— Get a folder
  • PATCH/api/v1/docs/folders/{id}— Update a folder
  • DELETE/api/v1/docs/folders/{id}— Delete a folder
Documents

Create, update, list, and delete documents. Documents have statuses (draft / review / published / archived) and versions are automatically saved on update.

  • GET/api/v1/docs/documents— List documents
  • POST/api/v1/docs/documents— Create a document
  • GET/api/v1/docs/documents/{id}— Get a document
  • PATCH/api/v1/docs/documents/{id}— Update a document
  • DELETE/api/v1/docs/documents/{id}— Delete a document
Document Versions

View document version history. When a document is updated, the previous content is automatically saved as a version. You can view the content of past versions.

  • GET/api/v1/docs/documents/{id}/versions— List document versions
  • GET/api/v1/docs/documents/{id}/versions/{versionId}— Get a document version
Audit Logs

View change history of document data.

  • GET/api/v1/docs/audit-logs— List audit logs