API Reference
API Reference Complete reference documentation for the Nuclom API, auto-generated from the OpenAPI specification.
Nuclom API Nuclom is a video collaboration platform that helps teams organize, share, and collaborate on video content. This API provides programmatic access to videos, organizations, series, comments, and more.
Version: 1.0.0 OpenAPI 3.1 Base URLs https://nuclom.com/apiProduction server
http://localhost:3000/apiLocal development server
Authentication Most endpoints require authentication using a Bearer token or session cookie. Endpoints marked with "Auth Required" need authentication.
Authorization: Bearer <token>
Endpoints Videos (18 endpoints) Video management endpoints
get /videosAuth Required List videos post /videosAuth Required Create video post /videos/uploadAuth Required Upload video get /videos/searchAuth Required Search videos get /videos/deletedAuth Required List deleted videos put /videos/{id}Auth Required Update video delete /videos/{id}Auth Required Delete video post /videos/{id}/restoreAuth Required Restore video get /videos/{id}/commentsList video comments post /videos/{id}/commentsAuth Required Add comment get /videos/{id}/chaptersList video chapters post /videos/{id}/chaptersAuth Required Create chapter get /videos/{id}/transcriptGet video transcript get /videos/{id}/code-snippetsList code snippets post /videos/{id}/code-snippetsAuth Required Create code snippet get /videos/{id}/progressAuth Required Get video progress put /videos/{id}/progressAuth Required Update video progress Series (8 endpoints) Video series/playlist management
get /seriesAuth Required List series post /seriesAuth Required Create series get /series/{id}Get series put /series/{id}Auth Required Update series delete /series/{id}Auth Required Delete series post /series/{id}/videosAuth Required Add video to series delete /series/{id}/videos/{videoId}Auth Required Remove video from series put /series/{id}/reorderAuth Required Reorder series videos Organizations (6 endpoints) Organization and team management
get /organizationsAuth Required List organizations post /organizationsAuth Required Create organization get /organizations/{id}Auth Required Get organization put /organizations/{id}Auth Required Update organization get /organizations/{id}/membersAuth Required List members post /organizations/{id}/invitationsAuth Required Invite member Comments (2 endpoints) Video comments and discussions
get /videos/{id}/commentsList video comments post /videos/{id}/commentsAuth Required Add comment Search (1 endpoints) Search functionality
get /videos/searchAuth Required Search videos Notifications (3 endpoints) User notifications
get /notificationsAuth Required List notifications put /notifications/{id}Auth Required Update notification post /notifications/mark-all-readAuth Required Mark all read Billing (5 endpoints) Subscription and billing management
get /billing/plansList plans get /billing/subscriptionAuth Required Get subscription get /billing/usageAuth Required Get usage post /billing/checkoutAuth Required Create checkout post /billing/portalAuth Required Create billing portal AI (1 endpoints) AI-powered video analysis
post /ai/analyzeAuth Required Analyze video Integrations (6 endpoints) Third-party integrations (Google Meet, Zoom)
get /integrations/google/statusAuth Required Google status get /integrations/google/recordingsAuth Required List Google recordings post /integrations/google/importAuth Required Import Google recording get /integrations/zoom/statusAuth Required Zoom status get /integrations/zoom/recordingsAuth Required List Zoom recordings post /integrations/zoom/importAuth Required Import Zoom recording Health (1 endpoints) System health endpoints
Data Models For detailed schema definitions, download the OpenAPI specification and view the components.schemas section.