Bold VideoDocs

Types

TypeScript types exported by @boldvideo/bold-js

Everything is typed, and every type is exported. Import what you need:

import type {
  Video,
  Playlist,
  Settings,
  AIEvent,
  Viewer,
  ViewerProgress,
} from '@boldvideo/bold-js';

Your editor's go-to-definition on any type gives you the authoritative, always-current shape. The list below is a map, not a mirror.

Content

Video, VideoAttachment, VideoDownloadUrls, VideoSubtitles, VideoTranscript, VideoMetadata, Playlist, ListVideosOptions, ListVideosLatestOptions, ListVideosIndexOptions

Settings & portal

Settings, Account, AccountAI, AssistantConfig, Portal, PortalLayout, PortalHero, PortalNavigation, PortalDisplay, PortalTheme, ThemeConfig, ThemeColors, MenuItem, CustomRedirect, AnalyticsProvider

AI

AIEvent (the streaming event union), AIResponse, AIUsage, AIContextMessage, ChatOptions, SearchOptions, RecommendationsOptions, RecommendationsResponse, Recommendation, RecommendationVideo, Conversation, ConversationMessage, ConversationMetadata, Source, Segment, Citation, ImageInput, MultimodalCapability

Viewers & progress

Viewer, CreateViewerData, UpdateViewerData, ViewerLookupParams, ViewerProgress, SaveProgressData, ListProgressOptions, ProgressListMeta

Community

Post, PostAuthor, Comment, CommentThread, CommentSummary, Reply, ReactionResponse, ReactionSummary, CommentReactionSummary, ListPostsOptions, CreatePostData, UpdatePostData, CreateCommentData, PaginatedResponse, PaginationMeta, UserSummary

Sessions & auth

AuthClientOptions, AuthSessionCreateData, AuthSessionCreateResponse, AuthSessionChallengeResponse, AuthSessionVerifyResponse, AuthActiveSession, AuthSessionPlatform, SessionManagementViewerState, SessionManagementSession, SessionManagementRevokeOptions, TravelVerdict

Errors

AIAPIError, AuthAPIError, CommunityAPIError, ViewerAPIError, SessionManagementAPIError. Thrown by the respective namespaces, each carrying the HTTP status.

Deprecated aliases

AskOptionsChatOptions · RecommendOptionsRecommendationsOptions · RecommendResponseRecommendationsResponse

On this page