Velt

Docs

• CLAUDE
• SKILLS SYNC PIPELINE
• WIREFRAME VARIABLES TEMPLATE
• Customize Behavior: Node configuration, edge expressions, parallel groups, SLAs, linter rules, events, errors, and the full object reference.
• Approval Engine (Beta): Multi-step approval workflows where AI agents and humans review work together.
• Setup: Build an approval flow end to end: define, dispatch, receive events, drive decisions.
• Chat SDK Adapter: Build a bot that reads and responds to Velt comment threads using the Chat SDK and @veltdev/chat-sdk-adapter.
• Customize Behavior
• Rewriter: Let users select text on your website and use AI to rewrite, improve, or comment on it — powered by any major LLM provider.
• Setup
• Generate Token
• Add Comment Annotations
• Delete Comment Annotations
• Get Comment Annotations
• Get Comment Annotations Count
• Update Comment Annotations
• Add Comments
• Delete Comments
• Get Comments
• Update Comments
• Add Documents
• Delete Documents
• Get Documents
• Move Documents
• Update Access for Documents
• Update Disabled State for Documents
• Update Documents
• Add Folder
• Get Folders
• Update Folder
• Update Access for Folders
• Delete All User Data: Remove All User data from Velt.
• Get All User Data: Get all feature data for a user stored in Velt.
• Get Delete All User Data Status: Get the status of the data deletion process for a user.
• Broadcast Event
• Delete Data by Location: Delete all data associated with a specific location
• Update Location: Update a Location's metadata
• Add Notifications
• Delete Notifications
• Get Config
• Get Notifications
• Set Config
• Update Notifications
• Add Organizations
• Delete Organizations
• Get Organizations
• Update Disabled State for Organizations
• Update Organizations
• Add User Groups
• Add Users to Groups
• Delete Users from Groups
• Add Users
• Delete Users: Remove Users from an Organization or a Document.
• Get Users
• Update Users
• Add Domains
• Delete Domains
• Add Activity Logs
• Delete Activity Logs
• Get Activity Logs
• Update Activity Logs
• Create Definition
• Delete Definition
• Get Definition
• List Definitions
• Update Definition
• Cancel Execution
• Dispatch Execution
• Get Execution
• Get Execution Events
• List Executions
• Cancel Step
• Record Agent Resolution
• Record Reviewer Decision
• Resolve Step
• Add Permissions
• Generate Signature
• Generate Token
• Get Permissions
• Remove Permissions
• Add Comment Annotations
• Delete Comment Annotations
• Get Comment Annotations Count
• Get Comment Annotations
• Update Comment Annotations
• Add Comments
• Delete Comments
• Get Comments
• Update Comments
• Add CRDT Data
• Get CRDT Data
• Update CRDT Data
• Add Documents
• Delete Documents
• Get Documents
• Migrate Documents
• Migrate Documents Status
• Move Documents
• Update Access for Documents
• Update Disabled State for Documents
• Update Documents
• Add Folder
• Delete Folder
• Get Folders
• Update Folder
• Update Access for Folders
• Delete All User Data: Remove All User data from Velt.
• Get All User Data: Get all feature data for a user stored in Velt.
• Get Delete All User Data Status: Get the status of the data deletion process for a user.
• Broadcast Event
• Add Notifications
• Delete Notifications
• Get Config
• Get Notifications
• Set Config
• Update Notifications
• Add Organizations
• Delete Organizations
• Get Organizations
• Update Disabled State for Organizations
• Update Organizations
• Add Presence
• Delete Presence
• Update Presence
• Get Recordings
• Ask AI
• Add User Groups
• Add Users to Groups
• Delete Users from Groups
• Add Users
• Delete Users: Remove Users from an Organization or a Document.
• Get Users
• Update Users
• Get Activity Config
• Update Activity Config
• Add Domains
• Create API Key
• Update API Key
• Get API Key Config
• Update API Key Config
• Get API Keys
• Reset Auth Token
• Get Auth Tokens
• Create Workspace
• Delete Domains
• Get Domains
• Get Email Verification Status
• Get Email Config
• Update Email Config
• Get Workspace
• Get Notification Config
• Update Notification Config
• Get Permission Provider Config
• Update Permission Provider Config
• Send Login Link
• Get Webhook Config
• Update Webhook Config
• API Methods Index
• React Hooks Index
• Data models
• Customize Behavior
• Activity Logs
• Setup
• Customize Behavior
• Arrows
• Setup
• Customize Behavior
• Comments Sidebar: Provide a toggleable sidebar to view and filter comments.
• Setup
• Customize Behavior
• Notifications: There are several options to send notifications to your users.
• Comments: Your users can add comments in context to ask questions, leave feedback, report bugs etc. We handle all complexity to ensure the comments are robust against content changes. We support many types of comment UX patterns as illustrated below.
• Ace Editor Setup
• Comments: Add comments to an HTML Canvas.
• Overview
• ChartJS Comments Setup
• Custom Charts Setup
• Highcharts Comments Setup
• NivoCharts Comments Setup
• CodeMirror Setup
• Freestyle Setup
• Inline Comments Setup
• Lexical Setup
• Lottie Player Setup
• Page Mode Setup
• Plate Setup
• Popover Setup
• Quill Setup
• SlateJS Setup
• Stream Setup
• Text Setup
• Tiptap Setup
• Custom Video Player Setup: Use this guide to add collaboration into your own custom video player.
• Prebuilt Video Player Setup: Use this guide if you want to set up a prebuilt video player from our SDK with collaborative features built in.
• Customize Behavior
• Comment Standalone Composer
• Setup
• Customize Behavior
• Comment Pin
• Setup
• Customize Behavior
• Standalone Comment Thread
• Setup
• Customize Behavior
• In-app Notifications
• Setup
• Customize Behavior
• Inline Reactions
• Setup
• Customize Behavior
• Recorder: The Recorder allows your users to create audio, screen, and video recordings.
• Setup
• Suggestions (Beta)
• Customize Behavior
• View Analytics
• Setup
• Node: Use the Velt Node SDK for self-hosting backend implementation or calling Velt's REST APIs directly from Node.js or TypeScript. Covers both sdk.selfHosting.* (MongoDB + AWS S3) and sdk.api.* (REST API, no database needed).
• Python: Use the Velt Python SDK for self-hosting backend implementation or calling Velt's REST APIs directly. Covers both sdk.selfHosting.* (MongoDB + AWS S3) and sdk.api.* (REST API, no database needed).
• Advanced Setup: Optional advanced configuration options for Velt SDK
• Overview: Use AI coding agents to build with Velt. Understand how plugins, the MCP installer, skills, the CLI, and the Velt Docs MCP work together.
• Velt CLI: Use the add-velt CLI to scaffold Velt collaboration features into your Next.js app with a single command.
• Velt Installation MCP: Use the Velt MCP server to install collaboration features into React and Next.js projects through your AI coding agent.
• Overview
• AI Plugins: Install the Velt plugin in Cursor or Claude Code to get skills, rules, an expert agent, and MCP servers for building with the Velt SDK.
• Quickstart: Install and set up Velt in minutes in React, Angular, Vue, or HTML.
• Quickstart Old Copy: Quickstart for React. For other frameworks like vue, angular, svelte, vanilla js etc. check out the setup guide.
• Agent Skills: Use Velt Agent Skills to get accurate, best-practice code from AI coding agents like Claude Code, Cursor, and GitHub Copilot.
• CSS Injection
• Dark Mode
• Global Styles
• Customize Behavior
• Overview
• Setup
• AG Grid
• Overview
• Customize Behavior
• Customize UI
• Overview
• Setup
• MCP Servers (Beta)
• Managing Different Environments: Manage production, staging, and development environments with Velt API keys
• Migrate from Cord to Velt
• Migrate from Liveblocks to Velt
• Parts
• Slots
• Variables
• Invite: A widget to invite others to collaborate together on a project
• Setup
• Overview: CRDT (Yjs) based collaborative editing.
• BlockNote Editor: Setup Multiplayer Editing for BlockNote Editor.
• CodeMirror Editor: Setup Multiplayer Editing for CodeMirror Editor.
• Core Setup: Setup Multiplayer Editing for any frameworks or custom implementations.
• Array Store: Add real-time collaborative lists and collections to your application using Velt CRDT.
• Map Store: Add real-time collaborative key-value data to your application using Velt CRDT.
• Text Store: Add real-time collaborative text data to your application using Velt CRDT.
• XML Store: Add real-time collaborative XML/tree data to your application using Velt CRDT.
• React Flow Editor: Setup Multiplayer Editing for React Flow diagrams.
• Tiptap Editor: Setup Multiplayer Editing for Tiptap Editor.
• Customize Behavior
• Overview: Your users can view each other's cursors when interacting on the same document. This makes your app more alive. We handle the complexity of adapting the cursors to different screen sizes, differences in content etc.
• Setup
• Customize Behavior
• Overview: This is like Figma's follow along feature. Start a shared session in a click. One person is the leader, and whatever they do - like clicking, scrolling, or navigating - happens automatically on everyone else's screen.
• Setup
• Customize Behavior
• Overview: Enable slack-style effortless audio, video and screen sharing discussions inside your own product. It even comes with built in chat.
• Setup
• Webhooks
• Customize Behavior
• Overview: Your users can see what part of the document others are interacting with in real-time.
• Setup
• Overview: Sync and broadcast data in real-time across all connected clients.
• Redux Middleware
• Setup
• Customize Behavior
• Overview: Your users can see other users online on the document. This makes your app feel alive.
• Setup
• Customize Behavior
• Overview: Allow only one user to edit at a time but still allow everyone to see the changes as they happen.
• Setup: Enable Single Editor Mode to allow only one user to edit at a time while others remain in read-only mode.
• Overview
• Setup
• Version 3.0.0
• April 16 2024
• April 24 2024
• Aug 12 2024
• Aug 13 2024
• Aug 14 2024
• Aug 16 2024
• Aug 21 2024
• Aug 22 2024
• Aug 6 2024
• Aug 8 2024
• Dec 28 2023
• Feb 13 2024
• Feb 20 2024
• Feb 27 2024
• Jan 14 2024
• July 02 2024
• July 03 2024
• July 04 2024
• July 09 2024
• July 10 2024
• July 15 2024
• July 17 2024
• July 18 2024
• July 19 2024
• July 22 2024
• July 23 2024
• July 24 2024
• July 26 2024
• July 29 2024
• July 31 2024
• June 10 2024
• June 24 2024
• June 29 2024
• June 30 2024
• June 6 2024
• March 14 2024
• March 5 2024
• May 10 2024
• May 17 2024
• May 23 2024
• May 24 2024
• May 29 2024
• BlockNote CRDT Library: Release Notes of Changes Affecting Velt BlockNote Library
• CodeMirror CRDT Library: Release Notes of Changes Affecting Velt CodeMirror Library
• Core CRDT Library: Release Notes of Changes Affecting All CRDT Libraries
• Lexical Changelog: Release Notes of Changes Affecting Velt Lexical Library
• React Flow CRDT Library: Release Notes of Changes Affecting Velt React Flow Library
• Velt SDK Changelog: Release Notes of changes added to the core Velt SDK
• Tiptap CRDT Library: Release Notes of Changes Affecting Velt Tiptap CRDT Library
• Upgrade Guide
• Core CRDT Library: Release Notes of Changes Affecting All CRDT Libraries
• Velt SDK Changelog: Release Notes of changes added to the core Velt SDK
• Upgrade Guide
• Generating Auth Tokens
• Content security policy
• JWT Tokens: Generate JWT Tokens for additional security
• Proxy Server
• Supported Regions
• Activity: Self-host your activity log PII data while using Velt's components. Keep activity content, entity snapshots, and custom fields on your infrastructure with only minimal identifiers stored on Velt servers.
• Attachments: Self-host your comments file attachments data while using Velt's components. Keep attachment storage on your infrastructure with minimal metadata stored on Velt servers.
• Comments: Self-host your comments data while using Velt's components. Keep comment storage on your infrastructure with minimal metadata stored on Velt servers.
• Notifications: Self-host your custom notification PII data while using Velt's notification components. Keep notification content on your infrastructure with only minimal identifiers stored on Velt servers.
• Overview: Self-host the user generated content on your infrastructure while storing only minimal identifiers on Velt servers.
• Reactions: Self-host your reactions data while using Velt's components. Keep reaction storage on your infrastructure with minimal metadata stored on Velt servers.
• Recordings: Self-host your recording annotation PII data while using Velt's components. Keep recorded files, identity, transcription, and attachment URLs on your infrastructure with only minimal identifiers stored on Velt servers.
• Users: Self-host your users' PII while using Velt's collaboration features. Keep sensitive user data on your infrastructure with only user IDs stored on Velt servers.
• Temp release notes
• Temp release notes input
• Conditional Templates
• Action Components
• Activity Logs Primitives: Standalone primitive components for building custom Activity Logs interfaces.
• Activity Logs Wireframe Variables: Template variables exposed by the Activity Logs wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Activity Logs Wireframes: The Activity Logs displays a chronological feed of user actions. Customize the layout using VeltActivityLogWireframe and its sub-components.
• Area Wireframe Variables: Template variables exposed by the Area wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Custom Button
• Parts
• Slots
• Variables
• Arrows Wireframe Variables: Template variables exposed by the Arrows feature — read them with velt-data, velt-if, and velt-class once wireframe-tag interpolation ships.
• Autocomplete Wireframe Variables: Template variables exposed by the Autocomplete wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Comment Bubble Primitives: Primitive-based components for building custom Comment Bubble interfaces with maximum flexibility.
• Comment Bubble Wireframe Variables: Template variables exposed by the Comment Bubble wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Comment Bubble Wireframes: Wireframe components for building custom Comment Bubble interfaces with maximum flexibility.
• Comment Dialog — Structure: Canonical structure for the Velt Comment Dialog Wireframe (React & HTML mirrors). Order follows your provided JSX/HTML. Parent/child is defined only by the extension path. Direct children are marked with (Leaf) when they have no descendants.
• Comment Dialog Primitives: 94+ primitive components for building custom Comment Dialog interfaces with maximum flexibility.
• Comment Dialog Wireframe Variables: Template variables exposed by the Comment Dialog wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Comment Dialog Wireframes: Wireframe components for building custom Comment Dialog interfaces with maximum flexibility.
• Comment Pin Primitives: Primitive-based components for building custom Comment Pin interfaces with maximum flexibility.
• Comment Pin Wireframes: Wireframe components for building custom Comment Pin interfaces with maximum flexibility.
• Comment Player Timeline
• Comments Sidebar Button Primitives: Primitive-based components for building custom Comments Sidebar Button interfaces with maximum flexibility.
• Comment Sidebar Button Wireframe Variables: Template variables exposed by the Comment Sidebar Button wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Comments Sidebar Button Wireframes: Wireframe components for building custom Comments Sidebar Button interfaces with maximum flexibility.
• Comments Sidebar — Structure: Canonical structure for the Velt Comments Sidebar Wireframe (React only). Order follows your provided JSX. Parent/child is defined ONLY by dot-path extensions. Direct children with no descendants are marked (Leaf).
• Comments Sidebar V2 — Structure: Canonical structure for the Velt Comments Sidebar V2 Wireframe. Order follows the provided JSX. Parent/child is defined ONLY by dot-path extensions. Direct children with no descendants are marked (Leaf).
• Comment Sidebar v1 Wireframes: Comment Sidebar Component.
• Comment Sidebar V2 Primitives: 27+ primitive components for building custom Comment Sidebar V2 interfaces with maximum flexibility.
• Comment Sidebar v2 Wireframes: Comment Sidebar V2 Component — primitive-based wireframe with 27+ standalone primitives.
• Comment Sidebar Wireframe Variables: Template variables exposed by the Comment Sidebar wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Comment Tool: The button to add new comments.
• Comment Tool Wireframe Variables: Template variables exposed by the Comment Tool wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Velt Video Player
• Confirmation Dialog: The Confirmation Dialog that appears when you delete a comment annotation.
• Inline Comments Section Primitives: Primitive-based components for building custom Inline Comments Section interfaces with maximum flexibility.
• Inline Comments Section Wireframe Variables: Template variables exposed by the Inline Comments Section wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Inline Comments Section Wireframes: Wireframe components for building custom Inline Comments Section interfaces with maximum flexibility.
• MultiThread Comment Dialog Primitives: Primitive-based components for building custom MultiThread Comment Dialog interfaces with maximum flexibility.
• Multithread Comments Wireframe Variables: Template variables exposed by the Multithread Comments wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• MultiThread Comment Dialog Wireframes: Wireframe components for building custom MultiThread Comment Dialog interfaces with maximum flexibility.
• Persistent Comment Mode Banner: The persistent comment mode banner that appears when persistent mode is enabled and user is adding a comment.
• Comment Composer
• Comment Thread
• Text Comment Primitives: Primitive-based components for building custom Text Comment interfaces with maximum flexibility.
• Text Comment Wireframe Variables: Template variables exposed by the Text Comment wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Text Comment Tool Primitives: Primitive-based components for building custom Text Comment Tool interfaces with maximum flexibility.
• Text Comment Tool Wireframes: Wireframe components for building custom Text Comment Tool interfaces with maximum flexibility.
• Text Comment Toolbar Primitives: Primitive-based components for building custom Text Comment Toolbar interfaces with maximum flexibility.
• Text Comment Toolbar Wireframes: Wireframe components for building custom Text Comment Toolbar interfaces with maximum flexibility.
• Inline Reactions Section: This component is used to render the reaction tool and all the reactions.
• Notifications Panel Primitives: Primitive components for building custom Notifications panel interfaces.
• Notifications Panel Wireframe Variables: Template variables exposed by the Notifications Panel wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Notifications Panel Wireframes: Wireframes for the Notifications Panel.
• Notifications Tool Primitives: Pprimitive components for building custom Notifications tool interfaces with maximum flexibility.
• Notifications Tool Wireframe Variables: Template variables exposed by the Notifications Tool wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Notifications Tool Wireframes: Wireframes for the Notifications Tool.
• Reactions Wireframe Variables: Template variables exposed by the Reactions wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Control Panel: Recorder control panel component.
• Media Source Settings: Media source settings component.
• Recorder player: Recorder player component. This is the small player that appears when a recording is done.
• Recorder Player Expanded: Recorder player expanded component. This is the expanded player that appears when user wants to view the recording in full screen.
• Recorder Tool: The button to add new recordings.
• Recording Preview Steps Dialog: Recording preview steps dialog component.
• Subtitles: Subtitles component.
• Transcription: Transcription component.
• Transcription Wireframe Variables: Template variables exposed by the Transcription, Subtitles, and Subtitles Dialog wireframes — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Video Editor: Video editor component.
• Recorder Wireframe Variables: Template variables exposed by the Recorder wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Rewriter Wireframe Variables: Template variables exposed by the Rewriter wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Tag Wireframe Variables: Template variables exposed by the Tag feature — read them with velt-data, velt-if, and velt-class once wireframe-tag interpolation ships.
• View Analytics Wireframe Variables: Template variables exposed by the View Analytics wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Cursors: The Cursors component displays the cursors of users in a document.
• Cursors Wireframe Variables: Template variables exposed by the Cursors wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Parts
• Slots
• Variables
• Huddle Wireframe Variables: Template variables exposed by the Huddle wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Live Selection
• Live Selection Wireframe Variables: Template variables exposed by the Live Selection wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Presence: The Presence component displays the avatars of users in a room.
• Presence Wireframe Variables: Template variables exposed by the Presence wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling.
• Single Editor Mode: Wireframes for the Single Editor Mode Panel.
• Layout Customization
• Localisation
• Overview
• Setup Wireframes
• CSS Customization
• Template Variables
• Advanced Webhooks
• Basic Webhooks

OpenAPI Specs

• openapi
• package
• package-lock

Optional

• Examples
• DevTools