Velt

Velt is a real-time collaboration platform delivered primarily as a client SDK (React components and framework wrappers) for adding presence, live cursors, comments, notifications, huddles, recordings, and live selection to applications. Its server-side surface is the Velt Data (REST) API at api.velt.dev plus signed, retried webhooks, letting backends read and write comments, users, organizations, folders, documents, notifications, and user groups programmatically.

7 APIs 0 Features

Real-Time CollaborationCommentsPresenceNotificationsSDKWebhooks

APIs

Velt Comments API

Server-side CRUD over comment threads and their annotations - add, get, update, and delete comments and comment annotations, and retrieve annotation counts - scoped by organizat...

Velt Users API

Add, get, update, and delete the end users that participate in collaboration, plus user-group membership operations, so backends can keep Velt identities in sync with the host a...

Velt Organizations API

Manage organizations - the top-level tenancy boundary in Velt - with add, get, update, delete, and enable/disable operations that partition collaboration data and access across ...

Velt Documents API

Create and manage documents and folders - the addressable surfaces that collaboration is attached to - including add, get, update, move, migrate, delete, access-control, and dis...

Velt Notifications API

Add, get, update, and delete notifications and read or set per-user and per-organization notification config (inbox and email delivery), driving the notification and inbox compo...

Velt Webhooks API

Configure advanced webhook endpoints and subscribe to collaboration events (for example newly-added and status-change actions on comments) generated by humans and agents. Delive...

Velt Auth Tokens API

Workspace-level management of API keys and auth tokens - create, get, and update API keys, read and update API key config, reset auth tokens, and generate the short-lived tokens...

Collections

Velt Data (REST) API

OPEN

Pricing Plans

Velt Plans Pricing

3 plans

PLANS

Rate Limits

Velt Rate Limits

4 limits

RATE LIMITS

FinOps

Velt Finops

FINOPS

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Velt Data (REST) API
  version: '2.0'
request:
  auth:
    type: apikey
    apikey:
      key: x-velt-api-key
      value: '{{veltApiKey}}'
      in: header
items:
- info:
    name: Comments
    type: folder
  items:
  - info:
      name: Get comments
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/comments/get
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "documentIds": ["<string>"] } }'
    docs: Retrieve comment threads for one or more documents in an organization.
  - info:
      name: Add comments
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/comments/add
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "documentId": "<string>", "comments": [] } }'
    docs: Create one or more comment threads on a document.
  - info:
      name: Get comment annotations count
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/comments/annotations/count/get
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "documentIds": ["<string>"] } }'
    docs: Return the annotation count for one or more documents.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Add users
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/users/add
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "users": [] } }'
    docs: Add end users to an organization.
  - info:
      name: Get users
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/users/get
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>" } }'
    docs: List users in an organization.
- info:
    name: Organizations
    type: folder
  items:
  - info:
      name: Add organizations
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/organizations/add
      body:
        type: json
        data: '{ "data": { "organizations": [] } }'
    docs: Create one or more organizations.
  - info:
      name: Get organizations
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/organizations/get
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>" } }'
    docs: Get organizations.
- info:
    name: Documents
    type: folder
  items:
  - info:
      name: Add documents
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/documents/add
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "documents": [] } }'
    docs: Add documents to an organization.
  - info:
      name: Get documents
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/documents/get
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "documentIds": ["<string>"] } }'
    docs: Get documents.
- info:
    name: Notifications
    type: folder
  items:
  - info:
      name: Get notification config
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/notifications/config/get
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "userId": "<string>", "documentIds": ["<string>"], "getOrganizationConfig":
          false } }'
    docs: Read inbox and email notification config for a user or organization.
  - info:
      name: Add notifications
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/notifications/add
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "notifications": [] } }'
    docs: Create notifications for users.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: Create advanced webhook endpoint
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/webhooks/endpoints/create
      body:
        type: json
        data: '{ "data": { "organizationId": "<string>", "url": "https://example.com/velt-webhook", "eventTypes": ["comment.newlyAdded",
          "comment.statusChanged"] } }'
    docs: Register a webhook endpoint and subscribe to collaboration event types.
- info:
    name: Auth
    type: folder
  items:
  - info:
      name: Create API key
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/workspace/apikey/create
      body:
        type: json
        data: '{ "data": {} }'
    docs: Provision a new workspace API key and auth token.
  - info:
      name: Reset auth token
      type: http
    http:
      method: POST
      url: https://api.velt.dev/v2/workspace/apikey/auth-token/reset
      body:
        type: json
        data: '{ "data": {} }'
    docs: Reset the auth token for a workspace API key.