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.
APIs.json: https://raw.githubusercontent.com/api-evangelist/velt/refs/heads/main/apis.yml
- Real-Time Collaboration
- Comments
- Presence
- Notifications
- SDK
- Webhooks
- Created: 2026-07-01
- Modified: 2026-07-01
Server-side CRUD over comment threads and their annotations - add, get, update, and delete comments and comment annotations, and retrieve annotation counts - scoped by organization and document. Comments are the collaboration data the client SDK renders in-app.
- Human URL: https://velt.dev/docs/api-reference/rest-apis
- Base URL:
https://api.velt.dev/v2
- Comments
- Annotations
- Collaboration
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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 application's user directory.
- Human URL: https://velt.dev/docs/api-reference/rest-apis
- Base URL:
https://api.velt.dev/v2
- Users
- Identity
- Collaboration
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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 teams and customers.
- Human URL: https://velt.dev/docs/api-reference/rest-apis
- Base URL:
https://api.velt.dev/v2
- Organizations
- Tenancy
- Access
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create and manage documents and folders - the addressable surfaces that collaboration is attached to - including add, get, update, move, migrate, delete, access-control, and disabled-state operations.
- Human URL: https://velt.dev/docs/api-reference/rest-apis
- Base URL:
https://api.velt.dev/v2
- Documents
- Folders
- Access Control
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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 components rendered by the SDK.
- Human URL: https://velt.dev/docs/api-reference/rest-apis/v2/notifications/get-config
- Base URL:
https://api.velt.dev/v2
- Notifications
- Inbox
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Configure advanced webhook endpoints and subscribe to collaboration events (for example newly-added and status-change actions on comments) generated by humans and agents. Deliveries are HMAC-signed, verified via the signature header, and retried with exponential backoff.
- Human URL: https://velt.dev/docs/webhooks/advanced
- Base URL:
https://api.velt.dev/v2
- Webhooks
- Events
- HMAC
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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 and signatures that authorize SDK and Data API calls.
- Human URL: https://velt.dev/docs/api-reference/rest-apis
- Base URL:
https://api.velt.dev/v2
- Authentication
- API Keys
- Tokens
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
FN: Kin Lane Email: kin@apievangelist.com