v1.0 — phase 1· 120 endpoints · 21 resource groups · 7 roles · 4 permission levels

REST API Reference

Resource-oriented URLs. JSON-encoded responses. ABAC permissions on every grant. Hash-chained audit log. All endpoints are prefixed with /api/v1.

API Conventions

Base path	/api/v1/
Authentication	Authorization: Bearer <JWT> on every non-PUBLIC endpoint (ZITADEL or Keycloak)
Dev bypass	With DEV_BYPASS_AUTH=true: Bearer dev-bypass (admin) or Bearer lt_<N> (user N)
Content type	application/json for bodies; multipart/form-data for file uploads
Pagination	page (1-based) + size query params → { items, total, page, page_size, pages }
Error format	{ "detail": "<message>", "error_code": "<CODE>" } with appropriate HTTP status
Soft deletes	DELETE performs soft-delete; rows remain in DB with deleted=true
Timestamps	ISO 8601 UTC on every datetime field
IDs	All resource IDs are 64-bit integers
API explorer	Swagger UI: /api/docs · ReDoc: /api/redoc · OpenAPI JSON: /api/openapi.json

Authentication Header

# Every non-PUBLIC endpoint requires this header Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... # Obtained via the OIDC PKCE flow (ZITADEL or Keycloak) # Service accounts: exchange the IdP JSON key for a JWT

Pagination Envelope

{ "items": [...], "total": 142, "page": 1, "page_size": 20, "pages": 8 }

Endpoint Reference

favorite

Health

2 endpoints

Method	Path	Auth	Description
GET	/api/v1/health	PUBLIC	Liveness probe. Returns {"status":"ok"} if the process is alive.
GET	/api/v1/health/ready	PUBLIC	Readiness probe. Per-service status for DB, Redis, MinIO.

lock_open

Authentication & Profile

9 endpoints

Method	Path	Auth	Description
POST	/api/v1/auth/callback	Any	Called after the OIDC callback; records LOGIN audit and returns the user profile.
POST	/api/v1/auth/logout	Any	Records the LOGOUT audit event.
GET	/api/v1/auth/me	Any	Return the current authenticated user profile.
PUT	/api/v1/auth/me	Any	Update the current user (name, avatar, job_title, phone, bio, timezone, locale).
GET	/api/v1/auth/me/notifications/preferences	Any	Return notification preferences for the current user.
PUT	/api/v1/auth/me/notifications/preferences	Any	Update notification preferences (email_on_mention, push_enabled, etc.).
POST	/api/v1/auth/me/2fa/enable	Any	Begin TOTP 2FA setup. Returns an otpauth:// provisioning URI; not active until verified.
POST	/api/v1/auth/me/2fa/verify	Any	Verify a TOTP code and activate 2FA on the account.
DELETE	/api/v1/auth/me/2fa	Any	Disable 2FA. Requires the current valid TOTP code in the body.

group

Users

4 endpoints

Method	Path	Auth	Description
GET	/api/v1/users	MANAGER+	List users in the caller’s organization (paginated).
GET	/api/v1/users/{user_id}	Any	Get a single user by ID. Org-scoped.
PUT	/api/v1/users/{user_id}/role	ADMIN+	Change a user’s system role.
DELETE	/api/v1/users/{user_id}	ADMIN+	Soft-deactivate a user. Caller cannot deactivate themselves.

domain

Organizations

6 endpoints

Method	Path	Auth	Description
GET	/api/v1/organizations/me	Any	Get the current user’s organization profile (plan, storage, feature flags).
PUT	/api/v1/organizations/me	ADMIN+	Update organization settings (name, logo, website, etc.).
GET	/api/v1/organizations/me/stats	Any	Dashboard stats: documents, storage, users, active workflows, status breakdown.
GET	/api/v1/organizations	SUPER_ADMIN	Cross-org list of every organization on the platform.
GET	/api/v1/organizations/me/idp-role-mapping	ADMIN+	Read the IdP role mapping (Keycloak realm roles → VyXlo roles).
PUT	/api/v1/organizations/me/idp-role-mapping	ADMIN+	Replace the IdP role mapping. Values must be valid VyXlo role names.

corporate_fare

Departments

5 endpoints

Method	Path	Auth	Description
GET	/api/v1/departments	Any	List all departments in the current organization.
GET	/api/v1/departments/{dept_id}	Any	Get a single department by ID.
POST	/api/v1/departments	MANAGER+	Create a new department.
PUT	/api/v1/departments/{dept_id}	MANAGER+	Update department metadata.
DELETE	/api/v1/departments/{dept_id}	MANAGER+	Soft-delete a department.

description

Documents

22 endpoints

Method	Path	Auth	Description
GET	/api/v1/documents	Any	List documents in the org (paginated). Filter by folder_id.
POST	/api/v1/documents	Any	Create a document metadata record. File upload is a separate step.
POST	/api/v1/documents/batch	Any	Batch upload up to 100 files with optional per-file metadata. Async; poll batch_id for status.
GET	/api/v1/documents/batch/{batch_id}	Any	Poll a batch upload’s progress and per-file outcome.
GET	/api/v1/documents/starred	Any	List documents starred by the current user.
GET	/api/v1/documents/{document_id}	Any	Get a single document. Includes is_starred flag for the caller.
PUT	/api/v1/documents/{document_id}	WRITE	Update document metadata (title, type, sensitivity, tags, custom fields).
DELETE	/api/v1/documents/{document_id}	Owner / ADMIN+	Soft-delete a document (MinIO object preserved; admin-recoverable).
PATCH	/api/v1/documents/{document_id}/status	Any	Transition status (DRAFT → IN_REVIEW → APPROVED → PUBLISHED → ARCHIVED).
POST	/api/v1/documents/{document_id}/upload	WRITE	Upload binary content (multipart/form-data). Stored in MinIO.
GET	/api/v1/documents/{document_id}/download	READ	Return a 15-minute presigned MinIO URL. Bytes never flow through the API.
POST	/api/v1/documents/{document_id}/lock	WRITE	Claim an exclusive write lock. 409 Conflict if already locked.
POST	/api/v1/documents/{document_id}/unlock	Lock owner / ADMIN+	Release the write lock.
POST	/api/v1/documents/{document_id}/star	Any	Bookmark the document for the current user.
DELETE	/api/v1/documents/{document_id}/star	Any	Remove the bookmark.
GET	/api/v1/documents/{document_id}/retention	Any	Get retention status: retention_until, days_remaining, is_expired.
PUT	/api/v1/documents/{document_id}/retention	ADMIN+	Set or update the retention_until date.
DELETE	/api/v1/documents/{document_id}/retention	ADMIN+	Clear the retention date.
POST	/api/v1/documents/{document_id}/normalize	ADMIN+	Queue a PDF/A-2b normalization job. Creates a parallel ARCHIVAL version + DocumentLineage row.
GET	/api/v1/documents/{document_id}/thumbnail	Any	Return a 1-hour presigned URL to the 256×256 JPEG thumbnail. 404 until the worker has rendered it.
GET	/api/v1/documents/{document_id}/ai-suggestions	Any	Read stored AI suggestions (sensitivity, classification, summary, keywords). Does not call the LLM.
POST	/api/v1/documents/{document_id}/apply-ai-suggestions	EDITOR+ (MANAGER+ to lower sensitivity)	Apply AI-suggested values to the document. Lowering sensitivity requires MANAGER+.

folder

Folders

8 endpoints

Method	Path	Auth	Description
GET	/api/v1/folders	Any	List root folders for the organization (paginated).
POST	/api/v1/folders	Any	Create a folder. Body supports name, description, parent_folder_id, color, icon.
GET	/api/v1/folders/{folder_id}	Any	Get a folder by ID.
PUT	/api/v1/folders/{folder_id}	Owner / ADMIN+	Update folder metadata.
DELETE	/api/v1/folders/{folder_id}	Owner / ADMIN+	Soft-delete the folder. Documents inside are not deleted.
GET	/api/v1/folders/{folder_id}/children	Any	List immediate child folders.
POST	/api/v1/folders/{folder_id}/move	Owner / ADMIN+	Move a folder under a new parent. Cycle-detection prevents circular hierarchies.
GET	/api/v1/folders/{folder_id}/path	Any	Return the breadcrumb path from root to this folder.

admin_panel_settings

Permissions

8 endpoints

Method	Path	Auth	Description
GET	/api/v1/permissions/document/{document_id}	Any	List active permission grants on a document.
GET	/api/v1/permissions/folder/{folder_id}	Any	List active permission grants on a folder.
POST	/api/v1/permissions/document	Owner / ADMIN+	Grant a permission on a document. Optional ABAC conditions: ip_range, time_window, require_mfa.
POST	/api/v1/permissions/folder	Owner / ADMIN+	Grant a permission on a folder. Same condition shape as documents.
PUT	/api/v1/permissions/{permission_id}	Owner / ADMIN+	Update a grant’s level (READ → COMMENT → WRITE → ADMIN).
DELETE	/api/v1/permissions/{permission_id}	Owner / ADMIN+	Revoke a grant (soft delete). Cache is invalidated immediately.
GET	/api/v1/permissions/my/document/{document_id}	Any	Return the caller’s effective permission level on a document.
GET	/api/v1/permissions/my/folder/{folder_id}	Any	Return the caller’s effective permission level on a folder.

account_tree

Workflows

5 endpoints

Method	Path	Auth	Description
POST	/api/v1/workflows	WRITE on docs	Create one approval workflow per document in document_ids. Steps run sequentially.
GET	/api/v1/workflows/{workflow_id}	Any	Get a workflow with all its steps and current state.
POST	/api/v1/workflows/{workflow_id}/steps/{step_id}/approve	Assignee / ADMIN+	Approve a workflow step with an optional comment.
POST	/api/v1/workflows/{workflow_id}/steps/{step_id}/reject	Assignee / ADMIN+	Reject a step with a mandatory reason. Marks the whole workflow REJECTED.
DELETE	/api/v1/workflows/{workflow_id}	Initiator / ADMIN+	Cancel an active workflow.

chat_bubble

Comments

5 endpoints

Method	Path	Auth	Description
GET	/api/v1/comments/document/{document_id}	READ	List comments for a document, threaded with nested replies.
POST	/api/v1/comments/document/{document_id}	READ	Create a comment. parent_comment_id optional for replies.
PUT	/api/v1/comments/{comment_id}	Author	Update a comment’s content.
DELETE	/api/v1/comments/{comment_id}	Author / ADMIN+	Soft-delete a comment.
POST	/api/v1/comments/{comment_id}/resolve	Doc owner / ADMIN+	Mark a comment thread as resolved.

label

Method	Path	Auth	Description
GET	/api/v1/tags	Any	List all tags for the organization. Supports `search` query.
POST	/api/v1/tags	Any	Create a tag. 409 if slug already exists.
GET	/api/v1/tags/{tag_id}	Any	Get a single tag.
PUT	/api/v1/tags/{tag_id}	Any	Update tag name / colour.
DELETE	/api/v1/tags/{tag_id}	Any	Soft-delete a tag.
GET	/api/v1/tags/autocomplete	Any	Prefix-match autocomplete. Returns up to 10 matches.
GET	/api/v1/documents/{document_id}/tags	Any	List tags assigned to a document.
POST	/api/v1/documents/{document_id}/tags	WRITE	Idempotently assign tags to a document. Body: { "tag_ids": [...] }.
DELETE	/api/v1/documents/{document_id}/tags	WRITE	Remove tags from a document.

Search

2 endpoints

Method	Path	Auth	Description
GET	/api/v1/search	Any	Full-text search via PostgreSQL tsvector. Filters: folder_id, status, document_type.
GET	/api/v1/search/semantic	Any	pgvector cosine-similarity search. Requires ENABLE_AI_FEATURES. Params: q, threshold, limit.

psychology

Chat & AI

4 endpoints

Method	Path	Auth	Description
POST	/api/v1/chat/document/{document_id}	READ	Stream a RAG Q&A response via Server-Sent Events (text/event-stream). Body: { "question": "..." }.
GET	/api/v1/chat/sessions	Any	List the caller’s chat sessions. Filter by scope_type, scope_id.
GET	/api/v1/ai/documents/{document_id}	READ	Read stored AI fields: classification, summary, keywords, entities, chunk_index_status.
POST	/api/v1/ai/reindex/{document_id}	Owner / ADMIN+	Queue document for AI reprocessing. Resets ai_processed and chunk_index_status to QUEUED.

Share Links

3 endpoints

Method	Path	Auth	Description
POST	/api/v1/share-links	WRITE	Create a share link. Body: document_id, permission_level, expires_at, password, allowed_emails.
GET	/api/v1/share-links/{token}	PUBLIC	Validate a share token. Direct DB lookup — never cached. 410 if expired.
DELETE	/api/v1/share-links/{share_link_id}	Creator / ADMIN+	Deactivate a share link.

mail

Invitations

3 endpoints

Method	Path	Auth	Description
POST	/api/v1/users/invite	MANAGER+	Send a 24-hour invitation email. Body: email, role, department_id.
GET	/api/v1/invitations/{token}	PUBLIC	Check an invite’s validity without consuming it (used by the signup page).
POST	/api/v1/invitations/{token}/use	PUBLIC	Consume the invite and create the user account. Token invalidated after use.

notifications

Notifications

3 endpoints

Method	Path	Auth	Description
GET	/api/v1/notifications/unread-count	Any	Return the count of unread notifications.
GET	/api/v1/notifications	Any	List notifications (paginated). Optional `unread_only=true` filter.
POST	/api/v1/notifications/{notification_id}/read	Any	Mark a notification as read.

gavel

Legal Holds

6 endpoints

Method	Path	Auth	Description
POST	/api/v1/legal-holds	ADMIN+	Create a legal hold against a list of document_ids. Suspends deletion + retention expiry.
GET	/api/v1/legal-holds	ADMIN+	List legal holds for the current organization (paginated).
GET	/api/v1/legal-holds/{hold_id}	ADMIN+	Get a single hold including its attached document list.
POST	/api/v1/legal-holds/{hold_id}/documents	ADMIN+	Attach additional documents to an existing hold.
DELETE	/api/v1/legal-holds/{hold_id}/documents/{doc_id}	ADMIN+	Detach a single document from a hold.
DELETE	/api/v1/legal-holds/{hold_id}	ADMIN+	Release / deactivate a legal hold.

schema

Document Types & Schemas

10 endpoints

Method	Path	Auth	Description
GET	/api/v1/document-types	Any	List document types (org-specific + platform defaults).
POST	/api/v1/document-types	ADMIN	Create an org-specific document type.
GET	/api/v1/document-types/{code}	Any	Get a document type by code.
PUT	/api/v1/document-types/{code}	ADMIN	Update a document type.
DELETE	/api/v1/document-types/{code}	ADMIN	Archive (soft-delete) a document type.
GET	/api/v1/document-types/{code}/schemas	Any	List JSON-Schema versions for a document type.
POST	/api/v1/document-types/{code}/schemas	ADMIN	Publish a new schema version. Body: { "schema_json": {...} }.
GET	/api/v1/document-types/{code}/policies	Any	List policies bound to the document type.
POST	/api/v1/document-types/{code}/policies	ADMIN	Bind a policy to the document type. Body: { "policy_id": N }.
DELETE	/api/v1/document-types/{code}/policies/{policy_id}	ADMIN	Unbind a policy from the document type.

inventory

Audit Logs

2 endpoints

Method	Path	Auth	Description
GET	/api/v1/audit-logs/timeline	ADMIN+	Forensic timeline. Filters: user_id, ip_address, action, from, to.
GET	/api/v1/audit-logs/verify	SUPER_ADMIN	Walk every audit record in order and recompute its hash. Returns first_tampered_id if any.

cloud_download

Audit Exports

2 endpoints

Method	Path	Auth	Description
POST	/api/v1/audit-exports	ADMIN+	Queue a CSV+manifest ZIP export for a date range. Returns export_id; processed in the background.
GET	/api/v1/audit-exports/{export_id}	ADMIN+	Get export status and a 15-day presigned download URL when COMPLETED.

swap_horiz

WebSockets

2 endpoints

Method	Path	Auth	Description
WS	/api/v1/ws/collaborate/{document_id}?token=<jwt>	JWT	Real-time collaboration: presence, cursor positions, status changes, comment events.
WS	/api/v1/ws/notifications?token=<jwt>	JWT	Live notification stream for the current user. Pushes per-event payloads with running unread_count.

Role Hierarchy

Roles are ordered. Higher roles inherit every capability of lower roles. The numeric `level` is what the auth dependency compares against on every request.

Role	Level	Scope
SUPER_ADMIN	100	Cross-organization administration, audit verification
ADMIN	80	Full org management, role changes, legal holds, audit exports
MANAGER	60	Department management, invite users, create workflows
EDITOR	40	Create and edit documents, grant up to WRITE permission
USER	30	Standard document access per explicit permission grants
VIEWER	20	Read-only access to documents granted to them
GUEST	10	Minimal / public-only access

Permission Levels

Document and folder access is controlled by explicit grants, evaluated after role checks. Four levels — capabilities accumulate going down.

Level	view	comment	edit	share	manage
READ	✓
COMMENT	✓	✓
WRITE	✓	✓	✓
ADMIN	✓	✓	✓	✓	✓

Permission Resolution Waterfall

Document exists? — 404 if not.
Owner shortcut — always allowed (bypasses ABAC conditions).
Public document — READ allowed.
Direct document permission grant.
Folder permission grant (when no direct grant).
Department permission grant (when the user has a department).
Expiry check — denied if `expires_at` is in the past.
ABAC conditions — `ip_range`, `time_window`, `require_mfa`.

Cache key: vyxlo:permissions:{user_id}:read:{doc_id} with a 5-minute TTL. Always invalidated on grant/revoke; bypassed when an ABAC RequestContext is in play.

Data Models

Document Object

{ "id": 1042, "title": "Q4 Financial Report", "file_name": "q4-2025-financials.pdf", "file_size_bytes": 2048000, "mime_type": "application/pdf", "status": "APPROVED", // DRAFT|IN_REVIEW|APPROVED|PUBLISHED|ARCHIVED "document_type": "FINANCIAL", "sensitivity": "CONFIDENTIAL", "owner_id": 5, "organization_id": 2, "department_id": 8, "folder_id": 17, "current_version_number": 3, "view_count": 24, "download_count": 6, "comment_count": 4, "page_count": 18, "word_count": 4200, "checksum": "a3f2b1...", // SHA-256 for tamper detection "retention_until": "2027-12-31T23:59:59Z", "is_locked": false, "locked_by_id": null, "is_starred": true, "tags": ["finance", "Q4", "board"], "ai_processed": true, "ai_classification": "FINANCIAL_REPORT", "ai_confidence": 0.97, "ai_summary": "Quarterly financial results showing 18% revenue growth...", "ai_keywords": ["revenue", "Q4", "board"], "ai_entities": { "people": [...], "organizations": [...], "dates": [...] }, "ai_suggested_sensitivity": "CONFIDENTIAL", "chunk_index_status": "INDEXED", // NOT_INDEXED|QUEUED|INDEXED|FAILED "chunk_indexed_at": "2026-01-15T10:32:00Z", "created_at": "2026-01-14T09:00:00Z", "updated_at": "2026-01-15T11:00:00Z" }

Permission Grant Object (with ABAC conditions)

{ "id": 301, "level": "WRITE", // NONE|READ|COMMENT|WRITE|ADMIN "resource_type": "document", // "document" or "folder" "resource_id": 1042, "target_user_id": 12, "target_department_id": null, // grant to dept = all members inherit "expires_at": "2026-06-30T23:59:59Z", // null = permanent "note": "Temporary write access for Q4 close", "conditions": { "ip_range": ["10.0.0.0/8", "192.168.1.0/24"], "time_window": { "start": "09:00", "end": "18:00", "tz": "Asia/Dubai", "days": ["Mon","Tue","Wed","Thu","Fri"] }, "require_mfa": true }, "created_at": "2026-01-10T08:00:00Z" }

All ABAC conditions are AND-ed. conditions: null means unrestricted. Document owners always bypass ABAC conditions.

Workflow Object

{ "id": 88, "document_id": 1042, "name": "Q1 Report Approval", "status": "IN_PROGRESS", // PENDING|IN_PROGRESS|APPROVED|REJECTED|CANCELLED "created_by_id": 5, "expires_at": "2026-12-31T00:00:00Z", "created_at": "2026-01-15T12:00:00Z", "steps": [ { "id": 201, "step_number": 1, "assignee_id": 9, "description": "Legal review", "status": "APPROVED", // WAITING|PENDING|APPROVED|REJECTED "comment": "Looks good.", "decided_at": "2026-01-16T09:30:00Z" }, { "id": 202, "step_number": 2, "assignee_id": 3, "description": "Finance sign-off", "status": "PENDING", "comment": null, "decided_at": null } ] }

Audit Log Entry (hash-chained)

{ "id": 415221, "actor_user_id": 12, "action": "DOCUMENT_DOWNLOADED", "resource_type": "document", "resource_id": 1042, "ip_address": "203.0.113.42", "user_agent": "Mozilla/5.0 ...", "request_id": "req_8a4f...", "metadata": { "version": 3, "duration_ms": 184 }, "previous_hash": "9e47b1c0...", "hash": "f12a4d77...", // SHA-256(prev_hash + canonical_payload) "created_at": "2026-04-21T14:32:11Z" }

Each row’s hash commits to the previous row’s previous_hash. GET /audit-logs/verify walks the chain and returns first_tampered_id if any row has been altered.

Share Link Object

{ "id": 55, "token": "sl_abc123xyz", "url": "https://app.vyxlo.com/share/sl_abc123xyz", "document_id": 1042, "permission_level": "READ", "created_by_id": 5, "expires_at": "2026-02-01T23:59:59Z", "is_password_protected": true, "allowed_emails": ["partner@acme.com", "auditor@ext.com"], "access_count": 3, "is_active": true, "created_at": "2026-01-15T14:00:00Z" }

Real-Time Protocols

WSWebSocket — Document Collaboration

Authenticated using the OIDC JWT (passed as a query param or `Authorization` header).

ws://host/api/v1/ws/collaborate/{document_id}?token=<jwt> // Client → server: { "type": "presence", "action": "join" } { "type": "cursor", "position": { "line": 5, "col": 10 } } // Server → client: { "type": "presence", "users": [{ "id": 42, "name": "Alice" }] } { "type": "comment", "comment_id": 5, "action": "created" } { "type": "status_change", "new_status": "IN_REVIEW" }

WSWebSocket — Notifications

Per-user notification stream. Each event carries a running `unread_count`, so the client never has to re-poll.

ws://host/api/v1/ws/notifications?token=<jwt> // Server → client: { "type": "notification", "id": 101, "title": "Document shared with you", "body": "Alice shared 'Q4 Report' with you", "unread_count": 3 }

SSEServer-Sent Events — Document Q&A

The chat endpoint streams the LLM response token by token (text/event-stream). Citations and the token count arrive on the final `done` event.

POST /api/v1/chat/document/{document_id} { "question": "What are the key findings?" } // SSE stream response: data: {"token": "The "} data: {"token": "key "} data: {"token": "findings..."} ... data: {"done": true, "session_id": 42, "citations": [...], "token_count": 87}

File Downloads — Presigned URLs

File bytes never flow through the VyXlo API server. The download endpoint returns a 15-minute presigned MinIO URL; the client fetches the file directly from object storage. This scales to very large files without API server memory pressure.

GET /api/v1/documents/1042/download Authorization: Bearer <access_token> // Response: { "url": "https://minio.example.com/bucket/q4-financials.pdf?X-Amz-Expires=900...", "expires_in": 900 } // Client fetches directly from MinIO — zero API server bandwidth

Error Reference

Every error follows the same shape: {"detail": "...", "error_code": "..."} with the appropriate HTTP status.

Status	Class	When
400	BadRequestException	Malformed request or business rule violation
401	UnauthorizedException	Missing or invalid JWT
403	ForbiddenException	Authenticated but insufficient permission (or ABAC condition failed)
404	ResourceNotFoundException	Entity not found, or belongs to a different organization
409	ConflictException	State conflict (locked document, duplicate slug, active workflow exists)
410	Gone	Expired token or share link
422	Validation Error	Pydantic schema validation failed (invalid enum, missing required field)
500	Internal Server Error	Unexpected server error — request_id is in server logs

Resource Groups

Health2
Authentication & Profile9
Users4
Organizations6
Departments5
Documents22
Folders8
Permissions8
Workflows5
Comments5
Tags9
Search2
Chat & AI4
Share Links3
Invitations3
Notifications3
Legal Holds6
Document Types & Schemas10
Audit Logs2
Audit Exports2
WebSockets2

Live Explorer

Swagger UI available on every deployment

/api/docs

API Conventions

Authentication Header

Pagination Envelope

Endpoint Reference

Health

Authentication & Profile

Users

Organizations

Departments

Documents

Folders

Permissions

Workflows

Comments

Tags

Search

Chat & AI

Share Links

Invitations

Notifications

Legal Holds

Document Types & Schemas

Audit Logs

Audit Exports

WebSockets

Role Hierarchy

Permission Levels

Permission Resolution Waterfall

Data Models

Document Object

Permission Grant Object (with ABAC conditions)

Workflow Object

Audit Log Entry (hash-chained)

Share Link Object

Real-Time Protocols

WSWebSocket — Document Collaboration

WSWebSocket — Notifications

SSEServer-Sent Events — Document Q&A

File Downloads — Presigned URLs

Error Reference

Sections

Resource Groups