Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion ai/agent-comments.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Agent Comments"
sidebarTitle: "Agent Comments"
description: "Let your AI agents leave comments and findings directly in Velt by calling the Comments REST APIs."
description: "Let AI agents post comments, findings, and suggestions into Velt threads via the Comments REST APIs, with accept/reject reviewer workflows."
---

## What are agent comments?
Expand Down
4 changes: 2 additions & 2 deletions ai/approval-engine/customize-behavior.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Customize Behavior"
description: "Node configuration, edge expressions, parallel groups, SLAs, linter rules, events, errors, and the full object reference."
title: "Approval Engine: Customize Behavior"
description: "Reference for Approval Engine node configs, edge expressions, parallel groups, SLA deadlines, linter rules, events, and error handling."
---

This is the deep-dive reference. Setup covers the happy path. This page covers everything you reach for when you need precise control over node behavior, edge routing, quorum policies, SLA breaches, and event consumption.
Expand Down
2 changes: 1 addition & 1 deletion ai/approval-engine/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Approval Engine (Beta)"
sidebarTitle: "Overview"
description: "Multi-step approval workflows where AI agents and humans review work together."
description: "Run multi-step approval workflows where AI agents and humans review work together, with state, retries, quorum, SLAs, and webhooks built in."
---

## What is the Approval Engine?
Expand Down
4 changes: 2 additions & 2 deletions ai/approval-engine/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Setup"
description: "Build a review-and-approval workflow end to end: author a definition, dispatch a run, record a decision, and receive the outcome."
title: "Approval Engine Setup"
description: "Build a review-and-approval workflow end to end: author a definition, dispatch a run, record a human decision, and receive the outcome via webhook."
---

A hands-on guide to building your first workflow on the Approval Engine. By the end you'll have authored a workflow, dispatched a run against a work item, recorded a human decision, and received the outcome.
Expand Down
2 changes: 1 addition & 1 deletion ai/chat-sdk-adapter.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Chat SDK Adapter"
sidebarTitle: "Chat SDK Adapter"
description: "Build a bot that reads and responds to Velt comment threads using the Chat SDK and @veltdev/chat-sdk-adapter."
description: "Build platform-agnostic bots that read and reply to Velt comment threads using the Chat SDK and the @veltdev/chat-sdk-adapter package."
---

[Chat SDK](https://chat-sdk.dev) lets you build cross-platform bots whose logic
Expand Down
4 changes: 2 additions & 2 deletions ai/memory/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Setup"
description: "Set up Velt Memory end to end: add a knowledge source, ask a question, search past decisions, and pull a grounded suggestion."
title: "Velt Memory Setup"
description: "Set up Velt Memory end to end: add a knowledge source, ask a natural-language question, search past review decisions, and get a grounded suggestion."
---

A hands-on guide to building on Velt **Memory**, the review-intelligence layer. By the end you'll have added a knowledge source, asked a natural-language question, searched past review decisions, and pulled a grounded decision suggestion.
Expand Down
3 changes: 2 additions & 1 deletion ai/rewriter/customize-behavior.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Customize Behavior"
title: "Rewriter: Customize Behavior"
description: "Reference for Velt Rewriter methods like addComment to anchor AI suggestions, rewrites, and comments to selected text ranges inside your application."
---

# addComment
Expand Down
2 changes: 1 addition & 1 deletion ai/rewriter/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Rewriter"
sidebarTitle: "Overview"
description: "Let users select text on your website and use AI to rewrite, improve, or comment on itpowered by any major LLM provider."
description: "Let users select text in your app and use AI to rewrite, improve, or comment on it, powered by OpenAI, Anthropic, or any major LLM provider."
---

<Frame>
Expand Down
3 changes: 2 additions & 1 deletion ai/rewriter/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Setup"
title: "Rewriter Setup"
description: "Enable Velt Rewriter in your React, Next.js, or other framework app to add AI-powered text rewriting and inline suggestions on selected content."
---


Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/auth/generate-token.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Generate Token"
title: "Generate auth token (v1)"
description: "Generate a Velt JWT auth token using your API key and auth token. Encodes userId, organizationId and admin flag; expires in 48 hours."
api: "POST https://api.velt.dev/v1/auth/token/get"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Comment Annotations"
title: "Add comment annotations (v1)"
description: "Add comment annotations to a document via the v1 REST API. Attach comments to elements, text, or pages with HTML or plain text content."
api: "POST https://api.velt.dev/v1/commentannotations/add"
# api: "POST https://addcommentannotations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Delete Comment Annotations"
title: "Delete comment annotations (v1)"
description: "Delete comment annotations from a document using the v1 REST API. Filter by location IDs, annotation IDs, or user IDs for targeted removal."
api: "POST https://api.velt.dev/v1/commentannotations/delete"
# api: "POST https://deletecommentannotations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 'Get Comment Annotations Count'
title: 'Get comment annotations count (v1)'
description: "Retrieve total and unread comment annotation counts for up to 30 documents using the v1 REST API. Filter by user ID and status IDs."
api: 'POST https://api.velt.dev/v1/commentannotations/count/get'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Comment Annotations"
title: "Get comment annotations (v1)"
description: "Retrieve comment annotations from a document via the v1 REST API for SDK v3 or earlier. Filter by location IDs, annotation IDs, or user IDs."
api: "POST https://api.velt.dev/v1/commentannotations/get"
# api: "POST https://getcommentannotations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Comment Annotations"
title: "Update comment annotations (v1)"
description: "Update comment annotations on a document via the v1 REST API. Filter by location, annotation, or user IDs and modify status, assignees, and more."
api: "POST https://api.velt.dev/v1/commentannotations/update"
# api: "POST https://updatecommentannotations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Comments"
title: "Add comments to annotation (v1)"
description: "Add reply comments inside a specific Velt comment annotation using the v1 REST API. Authenticate with API key and auth token headers."
api: "POST https://api.velt.dev/v1/commentannotations/comments/add"
# api: "POST https://addcommentsincommentannotation.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Delete Comments"
title: "Delete comments from annotation (v1)"
description: "Delete individual reply comments from a Velt comment annotation using the v1 REST API. Filter by specific comment IDs for targeted removal."
api: "POST https://api.velt.dev/v1/commentannotations/comments/delete"
# api: "POST https://getcommentsincommentannotation.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Comments"
title: "Get comments in annotation (v1)"
description: "Retrieve reply comments inside a specific Velt comment annotation using the v1 REST API. Requires advanced queries and SDK v4. Filter by comment IDs."
api: "POST https://api.velt.dev/v1/commentannotations/comments/get"
# api: "POST https://getcommentsincommentannotation.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Comments"
title: "Update comments in annotation (v1)"
description: "Update individual reply comments inside a Velt comment annotation using the v1 REST API. Edit comment text and metadata by comment ID."
api: "POST https://api.velt.dev/v1/commentannotations/comments/update"
# api: "POST https://updatecommentsincommentannotation.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/documents/add-documents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Documents"
title: "Add documents (v1)"
description: "Add documents with metadata to a Velt organization using the v1 REST API. Provide document IDs, names, and custom fields in a single request."
api: "POST https://api.velt.dev/v1/organizations/documents/add"
# api: "POST https://adddocuments.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/documents/delete-documents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Delete Documents"
title: "Delete documents (v1)"
description: "Delete one or more documents from a Velt organization using the v1 REST API. Pass an array of document IDs to remove documents and their data."
api: "POST https://api.velt.dev/v1/organizations/documents/delete"
# api: "POST https://deletedocuments.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/documents/get-documents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Documents"
title: "Get documents (v1)"
description: "Retrieve specific documents or all documents in a Velt organization via the v1 REST API. Use this endpoint with SDK v3 or earlier versions."
api: "POST https://api.velt.dev/v1/organizations/documents/get"
# api: "POST https://getdocuments.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/documents/move-documents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Move Documents"
title: "Move documents to folder (v1)"
description: "Move up to 30 documents into a target folder within a Velt organization using the v1 REST API. Reorganize document hierarchy in bulk."
api: "POST https://api.velt.dev/v1/organizations/documents/move"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Access for Documents"
title: "Update document access type (v1)"
description: "Update the access type for one or many documents at once using the v1 REST API. Control public, restricted, or default document permissions."
api: "POST https://api.velt.dev/v1/organizations/documents/access/update"
# api: "POST https://updateaccessfordocuments.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Disabled State for Documents"
title: "Update document disabled state (v1)"
description: "Enable or disable read and write access for specific documents using the v1 REST API. Useful to suspend Velt access after trial or subscription ends."
api: "POST https://api.velt.dev/v1/organizations/documents/access/disablestate/update"
# api: "POST https://updatedisablestatefordocuments.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/documents/update-documents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Documents"
title: "Update documents (v1)"
description: "Update metadata for one or more documents in a Velt organization using the v1 REST API. Modify names, custom fields, and other document properties."
api: "POST https://api.velt.dev/v1/organizations/documents/update"
# api: "POST https://updatedocuments.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/folders/add-folder.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Folder"
title: "Add folder (v1)"
description: "Create a new folder inside a Velt organization using the v1 REST API. Requires advanced queries enabled and Velt SDK v4 series deployed."
api: "POST https://api.velt.dev/v1/organizations/folders/add"
---

Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/folders/get-folders.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Folders"
title: "Get folders (v1)"
description: "Retrieve a folder's metadata and its subfolders within a Velt organization using the v1 REST API. Requires advanced queries and SDK v4 series."
api: "POST https://api.velt.dev/v1/organizations/folders/get"
---

Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/folders/update-folder-access.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Access for Folders"
title: "Update folder access type (v1)"
description: "Update the access type for one or many folders at once using the v1 REST API. Control default, public, or restricted permissions for folders."
api: "POST https://api.velt.dev/v1/organizations/folders/access/update"
---

Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/folders/update-folder.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Folder"
title: "Update or move folder (v1)"
description: "Update folder metadata or move a folder and its contents to a new parent using the v1 REST API. Requires advanced queries and SDK v4 series."
api: "POST https://api.velt.dev/v1/organizations/folders/update"
---

Expand Down
4 changes: 2 additions & 2 deletions api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Delete All User Data"
description: "Remove All User data from Velt."
title: "Delete all user data (GDPR, v1)"
description: "Asynchronously delete all of a user's data from Velt for GDPR compliance, including comments, mentions, reactions, and organization access."
# api: "POST https://api.velt.dev/deleteusers"
api: "POST https://api.velt.dev/v1/users/data/delete"
---
Expand Down
4 changes: 2 additions & 2 deletions api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get All User Data"
description: "Get all feature data for a user stored in Velt."
title: "Get all user data (GDPR, v1)"
description: "Export all Velt feature data stored for a user for GDPR requests. Returns paginated chunks of 100 items per feature using nextPageToken."
api: "POST https://api.velt.dev/v1/users/data/get"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get Delete All User Data Status"
description: "Get the status of the data deletion process for a user."
title: "Get delete user data status (GDPR, v1)"
description: "Check the progress and status of an asynchronous GDPR user data deletion job in Velt. Poll this endpoint after starting a delete request."
api: "POST https://api.velt.dev/v1/users/data/delete/status"
---

Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/livestate/broadcast-event.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Broadcast Event"
title: "Broadcast live state event (v1)"
description: "Broadcast a live state event from your server to any Velt document using the v1 REST API. Pair with the Live State Sync feature for realtime updates."
api: "POST https://api.velt.dev/v1/livestate/broadcast"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Delete Data by Location"
description: "Delete all data associated with a specific location"
title: "Delete data by location (v1)"
description: "Delete all Velt feature data tied to a specific location, including comments, recordings, and other annotations, using the v1 REST API."
api: "POST https://api.velt.dev/v1/organizations/documents/locations/data/delete"
---

Expand Down
4 changes: 2 additions & 2 deletions api-reference/rest-apis/v1/locations/update-location.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Update Location"
description: "Update a Location's metadata"
title: "Update location (v1)"
description: "Update a Velt location's metadata within a document using the v1 REST API. Modify location names, custom fields, and other properties."
api: "POST https://api.velt.dev/v1/organizations/documents/locations/update"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Notifications"
title: "Add notifications (v1)"
description: "Create and send in-app notifications to Velt users using the v1 REST API. Trigger notifications from your server with custom payloads and targets."
api: "POST https://api.velt.dev/v1/notifications/add"
# api: "POST https://addnotifications.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Delete Notifications"
title: "Delete notifications (v1)"
description: "Delete in-app notifications from Velt using the v1 REST API. Remove specific notifications by ID to clean up notification feeds programmatically."
api: "POST https://api.velt.dev/v1/notifications/delete"
# api: "POST https://deletenotifications.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/notifications/get-config.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Config"
title: "Get notifications config (v1)"
description: "Retrieve a user's notifications configuration from Velt using the v1 REST API. Requires the notifications feature enabled in the Velt console."
api: "POST https://api.velt.dev/v1/notifications/config/get"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Notifications"
title: "Get notifications (v1)"
description: "Retrieve in-app notifications for Velt users via the v1 REST API. Use this endpoint with SDK v3 or earlier versions for notification feeds."
api: "POST https://api.velt.dev/v1/notifications/get"
# api: "POST https://getnotifications.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/notifications/set-config.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Set Config"
title: "Set notifications config (v1)"
description: "Set a user's notifications configuration in Velt using the v1 REST API. Requires the notifications feature enabled in the Velt console first."
api: "POST https://api.velt.dev/v1/notifications/config/set"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Notifications"
title: "Update notifications (v1)"
description: "Update existing in-app notifications in Velt using the v1 REST API. Modify notification content, status, or metadata after delivery."
api: "POST https://api.velt.dev/v1/notifications/update"
# api: "POST https://updatenotifications.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Organizations"
title: "Add organizations (v1)"
description: "Create new organizations and their metadata in Velt using the v1 REST API. Provision tenants for multi-org collaboration apps in a single call."
api: "POST https://api.velt.dev/v1/organizations/add"
# api: "POST https://addorganizations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Delete Organizations"
title: "Delete organizations (v1)"
description: "Delete one or more Velt organizations and all of their data using the v1 REST API. Pass an array of organization IDs to remove tenants in bulk."
api: "POST https://api.velt.dev/v1/organizations/delete"
# api: "POST https://deleteorganizations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Get Organizations"
title: "Get organizations (v1)"
description: "Retrieve specific Velt organizations by organization IDs using the v1 REST API. Use this endpoint with SDK v3 or earlier versions."
api: "POST https://api.velt.dev/v1/organizations/get"
# api: "POST https://getorganizations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Disabled State for Organizations"
title: "Update organization disabled state (v1)"
description: "Enable or disable read and write access for all documents in a Velt organization using the v1 REST API. Useful when suspending tenant access."
api: "POST https://api.velt.dev/v1/organizations/access/disablestate/update"
# api: "POST https://updatedisablestatefororganizations.api.velt.dev/"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Organizations"
title: "Update organizations (v1)"
description: "Update metadata for one or more existing Velt organizations using the v1 REST API. Modify org names, custom fields, and other tenant properties."
api: "POST https://api.velt.dev/v1/organizations/update"
# api: "POST https://updateorganizations.api.velt.dev/"
---
Expand Down
3 changes: 2 additions & 1 deletion api-reference/rest-apis/v1/user-groups/add-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add User Groups"
title: "Add user groups (v1)"
description: "Create user groups within a Velt organization using the v1 REST API. Organize members into groups for mentions, permissions, and team workflows."
api: "POST https://api.velt.dev/v1/organizations/usergroups/add"
# api: "POST https://addorganizationusergroups.api.velt.dev/"
---
Expand Down
Loading