Skip to main content

Documentation Index

Fetch the complete documentation index at: https://velt-velt-py-v0-1-10.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Libraries

  • velt-py
​
Python SDK (velt-py) v0.1.10
May 19, 2026

​
New Features

  • [Self Hosting]: PartialCommentAnnotation now exposes from (comment author), assignedTo, targetTextRange, and resolvedByUserId as first-class typed fields. These four keys previously fell through silently via extra_fields. Learn more →
  • [Self Hosting]: New PartialTargetTextRange dataclass (exported from velt_py.models) represents the selected text snippet a comment annotation is anchored to. Learn more →

​
Improvements

  • [Self Hosting]: BaseMetadata now models sdkVersion and documentMetadata, which were previously dropped silently; self-hosted Mongo writes now preserve both fields.
  • [Self Hosting]: Introduced an UNSET sentinel on resolvedByUserId to distinguish “field absent from payload” (no Mongo write) from “explicit null” (the frontend’s unresolve action — writes null to Mongo).

​
Bug Fixes

None.
​
Python SDK (velt-py) v0.1.9
April 20, 2026

​
New Features

  • [REST API Backend]: The sdk.api.* namespace is now available, introducing a REST API backend for the Python SDK with feature parity with the Velt Node SDK. Learn more →
  • [REST API Services]: 17 services are included: organizations, folders, documents, users, userGroups, notifications, commentAnnotations, activities, accessControl, crdt, presence, livestate, recordings, rewriter, gdpr, workspace, and token.
  • [Typed Request Dataclasses]: Every sdk.api.* method accepts a typed @dataclass request object (e.g., AddOrganizationsRequest) and returns the raw Velt API response without local reshaping or validation.
  • [camelCase Method Names]: All sdk.api.* method names are camelCase and match the JavaScript/Node SDK one-to-one.
  • [Custom Error Classes]: Three new error classes are available: VeltValidationError, VeltTokenError, and VeltApiError, all extending the base VeltSDKError.
  • [Environment Variable Support]: The SDK reads VELT_API_KEY, VELT_AUTH_TOKEN, VELT_WORKSPACE_ID, and VELT_WORKSPACE_AUTH_TOKEN from the environment for credential configuration.
  • [PyPI Distribution]: The package is published to PyPI as velt-py. Requires Python 3.8+; the requests library is installed automatically as a dependency.