No files yet
Drop files here or click Upload
Drop files here or click Upload
Configuration options for themes, storage, collaboration, and more will be available in a future update.
This is a proposed REST API for OpenDocs. Endpoints are designed to expose the current application capabilities as a backend service. Authentication, pagination, and error schemas are not yet defined.
Base URL https://api.opendocs.example/v1
/documents
List all documents
folderId search tags status sort limit offset
{ "documents": [...], "total": 28, "limit": 50, "offset": 0 }
/documents/{id}
Get document metadata
{ "id", "title", "creator", "status", "revision", "versions", ... }
/documents/{id}/content
Download file binary
Binary file stream (Content-Type from metadata)
/documents
Upload a new document
multipart/form-data: file, folderId, title, description, tags[], discipline, phase
{ "id": "doc-xxx", "slug": "...", "shareToken": "..." }
/documents/{id}
Update document metadata
/documents/{id}/versions
Upload a new version
multipart/form-data: file, comment
/documents/{id}
Move document to trash (soft delete)
/folders
List all folders
parentId
/folders
Create a folder
/folders/{id}
Rename or move folder
/folders/{id}
Delete folder and contents
/share/{token}
Resolve share link to document
/documents/{id}/share
Create or update share link
{ "email": "...", "permission": "view|edit" }
/documents/{id}/share/{email}
Revoke access
/search
Full-text search across documents and metadata
q folderId type tags discipline status limit
/project
Get project metadata
/tags
List all tags with document counts
/disciplines
List disciplines (Architektur, Bauleitung, ...)