# CollabKit

## Docs

- [API Overview](https://docs.collab-kit.com/api-reference/overview.md): Base URL, authentication, response format, and error codes for the CollabKit REST API.
- [Create Room](https://docs.collab-kit.com/api-reference/rooms/create-room.md): Create a new collaboration room.
- [Get Room](https://docs.collab-kit.com/api-reference/rooms/get-room.md): Get room details including its users.
- [Get Room by Custom ID](https://docs.collab-kit.com/api-reference/rooms/get-room-by-custom-id.md): Look up a room using its custom identifier.
- [List Rooms](https://docs.collab-kit.com/api-reference/rooms/list-rooms.md): List all rooms in your organization with pagination and search.
- [Delete File](https://docs.collab-kit.com/api-reference/storage/delete-file.md): Delete a file from storage.
- [Get File](https://docs.collab-kit.com/api-reference/storage/get-file.md): Serve a stored file by its key.
- [List Files](https://docs.collab-kit.com/api-reference/storage/list-files.md): List files in a room with optional filters.
- [Upload File](https://docs.collab-kit.com/api-reference/storage/upload-file.md): Upload a file to a room's storage.
- [Create User](https://docs.collab-kit.com/api-reference/users/create-user.md): Create a user in a room and get a JWT token for WebSocket auth.
- [Get User](https://docs.collab-kit.com/api-reference/users/get-user.md): Get user details and session history.
- [Get User by Custom ID](https://docs.collab-kit.com/api-reference/users/get-user-by-custom-id.md): Look up a user using their custom identifier.
- [List Users](https://docs.collab-kit.com/api-reference/users/list-users.md): List all users in a room with pagination and search.
- [Create Webhook](https://docs.collab-kit.com/api-reference/webhooks/create-webhook.md): Register a webhook to receive event notifications.
- [Delete Webhook](https://docs.collab-kit.com/api-reference/webhooks/delete-webhook.md): Delete a webhook registration.
- [Get Webhook](https://docs.collab-kit.com/api-reference/webhooks/get-webhook.md): Get details for a specific webhook.
- [List Deliveries](https://docs.collab-kit.com/api-reference/webhooks/list-deliveries.md): View the delivery log for a webhook.
- [List Webhooks](https://docs.collab-kit.com/api-reference/webhooks/list-webhooks.md): List all webhooks in your organization.
- [Update Webhook](https://docs.collab-kit.com/api-reference/webhooks/update-webhook.md): Update an existing webhook's configuration.
- [Create Workflow](https://docs.collab-kit.com/api-reference/workflows/create-workflow.md): Create a workflow that runs custom code on events.
- [Delete Workflow](https://docs.collab-kit.com/api-reference/workflows/delete-workflow.md): Delete a workflow.
- [Get Workflow](https://docs.collab-kit.com/api-reference/workflows/get-workflow.md): Get details for a specific workflow.
- [List Executions](https://docs.collab-kit.com/api-reference/workflows/list-executions.md): View the execution log for a workflow.
- [List Workflows](https://docs.collab-kit.com/api-reference/workflows/list-workflows.md): List all workflows in your organization.
- [Update Workflow](https://docs.collab-kit.com/api-reference/workflows/update-workflow.md): Update an existing workflow's configuration or code.
- [Authentication](https://docs.collab-kit.com/authentication.md): Understand how authentication works across the CollabKit platform.
- [Collaborative Editor](https://docs.collab-kit.com/guides/collaborative-editor.md): Build a real-time collaborative text editor with Yjs and TipTap.
- [Comments System](https://docs.collab-kit.com/guides/comments-system.md): Add threaded comments with reactions and user tagging to your app.
- [Live Cursor Tracking](https://docs.collab-kit.com/guides/cursor-tracking.md): Build a real-time cursor tracking experience with the Presence module.
- [File Sharing](https://docs.collab-kit.com/guides/file-sharing.md): Upload, share, and manage files within collaborative rooms.
- [Real-Time Stores](https://docs.collab-kit.com/guides/real-time-stores.md): Sync application state across users with schema-driven KV stores.
- [Webhooks & Workflows](https://docs.collab-kit.com/guides/webhooks-workflows.md): Automate server-side actions in response to collaboration events.
- [Introduction](https://docs.collab-kit.com/index.md): Build real-time collaborative apps and agents in minutes.
- [Quickstart](https://docs.collab-kit.com/quickstart.md): Get real-time collaboration running in your apps and agents in under 5 minutes.
- [Broadcasts](https://docs.collab-kit.com/sdk/broadcasts.md): Send custom events to other participants in real time.
- [Changelog](https://docs.collab-kit.com/sdk/changelog.md)
- [Comments](https://docs.collab-kit.com/sdk/comments.md): Add threaded comments with replies, reactions, and user tagging.
- [SDK Overview](https://docs.collab-kit.com/sdk/overview.md): Install and initialize the CollabKit browser SDK.
- [Presence](https://docs.collab-kit.com/sdk/presence.md): Share ephemeral state like cursors, selections, and scroll positions in real time.
- [Rooms](https://docs.collab-kit.com/sdk/rooms.md): Access room details, manage room state, and handle connection lifecycle.
- [Storage](https://docs.collab-kit.com/sdk/storage.md): Upload, list, and manage files scoped to rooms.
- [Stores](https://docs.collab-kit.com/sdk/stores.md): Schema-driven, type-safe KV stores synced in real time.
- [Users](https://docs.collab-kit.com/sdk/users.md): Track and manage all participants in a room.
- [CRDT (Yjs)](https://docs.collab-kit.com/sdk/yjs.md): Conflict-free collaborative editing with Yjs integration.
- [Enums & Constants](https://docs.collab-kit.com/types/constants.md): MessageType, ResponseCode, Module enums and exported constants.
- [Core Types](https://docs.collab-kit.com/types/core.md): User, Room, Organization, Comment, and Session types.
- [Presence Types](https://docs.collab-kit.com/types/presence.md): Types for ephemeral presence state.
- [Response Types](https://docs.collab-kit.com/types/responses.md): Standard response envelope and error types used by all API endpoints.
- [Socket Types](https://docs.collab-kit.com/types/socket.md): Types for WebSocket connection state and lifecycle events.
- [Storage Types](https://docs.collab-kit.com/types/storage.md): Types for file upload, listing, and filtering.
- [Store Types](https://docs.collab-kit.com/types/stores.md): Types for schema-driven KV store definitions and type inference.
- [Utility Methods](https://docs.collab-kit.com/types/utilities.md): Exported functions from @collab-kit/utils.
- [Webhook Types](https://docs.collab-kit.com/types/webhooks.md): Types for webhook registrations, payloads, and delivery logs.
- [Workflow Types](https://docs.collab-kit.com/types/workflows.md): Types for workflow registrations and execution logs.