addComment

Create a comment annotation anchored to the text range from a TextSelectedEvent.

Params: RewriterAddCommentRequest
Returns: Promise<RewriterAddCommentResponse>

React / Next.js
Other Frameworks

const rewriterElement = client.getRewriterElement();

const result = await rewriterElement.addComment({ text: 'Consider simplifying this.', event });

if (result.success) {
  console.log('Created annotation:', result.annotationId);
}

const rewriterElement = Velt.getRewriterElement();

const result = await rewriterElement.addComment({ text: 'Consider simplifying this.', event });

if (result.success) {
  console.log('Created annotation:', result.annotationId);
}

askAi

Send a text-generation prompt to any AI model via Velt’s proxy. The provider is resolved automatically from the model name prefix (gpt-*/o1-*/o3-*/o4-* → OpenAI, claude-* → Anthropic, gemini-* → Gemini).

Params: RewriterAskAiRequest
Returns: Promise<RewriterAskAiResponse>

React / Next.js
Other Frameworks

const rewriterElement = client.getRewriterElement();

const response = await rewriterElement.askAi({
  model: 'gemini-2.5-flash',
  prompt: 'Make it more formal',
  selectedText: event.text,
});

if (response.success) {
  console.log('AI output:', response.text);
}

const rewriterElement = Velt.getRewriterElement();

const response = await rewriterElement.askAi({
  model: 'gemini-2.5-flash',
  prompt: 'Make it more formal',
  selectedText: event.text,
});

if (response.success) {
  console.log('AI output:', response.text);
}

enableRewriter

React / Next.js
Other Frameworks

const rewriterElement = client.getRewriterElement();
rewriterElement.enableRewriter();
rewriterElement.disableRewriter(); //to disable

if (Velt) {
  const rewriterElement = Velt.getRewriterElement();
  rewriterElement.enableRewriter();
  rewriterElement.disableRewriter(); //to disable
}

on

Subscribe to Rewriter events. Supports 'textSelected' to receive a TextSelectedEvent whenever a user selects text in a Rewriter-enabled region.

Params: action: 'textSelected'
Returns: Observable<TextSelectedEvent>

React / Next.js
Other Frameworks

const rewriterElement = client.getRewriterElement();

rewriterElement.on('textSelected').subscribe((event) => {
  console.log('Selected text:', event.text);
});

const rewriterElement = Velt.getRewriterElement();

rewriterElement.on('textSelected').subscribe((event) => {
  console.log('Selected text:', event.text);
});

replaceText

Replace the DOM text identified by a TextSelectedEvent with new text.

Params: RewriterReplaceTextRequest
Returns: Promise<RewriterReplaceTextResponse>

React / Next.js
Other Frameworks

const rewriterElement = client.getRewriterElement();

const result = await rewriterElement.replaceText({ text: 'Replacement text', event });

if (result.success) {
  console.log('Replaced:', result.originalText, '→', result.replacedText);
}

const rewriterElement = Velt.getRewriterElement();

const result = await rewriterElement.replaceText({ text: 'Replacement text', event });

if (result.success) {
  console.log('Replaced:', result.originalText, '→', result.replacedText);
}

textSelected does not fire, and replaceText() returns success: false, for a selection inside TipTap or another ProseMirror-based editor.

enableDefaultUI

Show or hide the built-in Velt rewriter toolbar. Calling disableDefaultUI() suppresses the toolbar on text selection while keeping all rewriter events active, so you can render a fully custom UI. Call enableDefaultUI() to restore the default toolbar.

Returns: void

React / Next.js
Other Frameworks

const rewriterElement = client.getRewriterElement();

// Show the default Velt toolbar on text selection (default state)
rewriterElement.enableDefaultUI();

// Hide the default Velt toolbar; handle UI yourself
rewriterElement.disableDefaultUI();

const rewriterElement = Velt.getRewriterElement();

// Show the default Velt toolbar on text selection (default state)
rewriterElement.enableDefaultUI();

// Hide the default Velt toolbar; handle UI yourself
rewriterElement.disableDefaultUI();

Get Started

Agentic Setup

Key Concepts

Async Collaboration

Realtime Collaboration

AI

Self Hosting

Backend SDKs

Model Context Protocol

Webhooks

Security

Miscellaneous

Customize Behavior

addComment

askAi

enableRewriter

on

replaceText

enableDefaultUI

​addComment

​askAi

​enableRewriter

​on

​replaceText

​enableDefaultUI

addComment

askAi

enableRewriter

on

replaceText

enableDefaultUI