Documentation

    Documentation

    Documentation

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. /
    2. /VideoConductor

    Updated Jun 19, 20266 min listen

    1. /
    2. /VideoConductor

    Updated Jun 19, 20266 min listen

    1. /
    2. /VideoConductor

    Updated Jun 19, 20266 min listen

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    Integrations
    Ethereum wallets (Wagmi v3)

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    Integrations
    Ethereum wallets (Wagmi v3)

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    Integrations
    Ethereum wallets (Wagmi v3)

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)
    Docs
    Features
    Docs
    Features
    Docs
    Features

    VideoConductor

    VideoConductor is Ring Platform's async generative video layer — the video counterpart to ImageConductor. It polls xAI Grok Imagine Video, optionally uploads MP4s to ring-filebase, and records an audit row in PostgreSQL generated_videos.

    Executive summary

    Operators and agents call ring-video-create (MCP) or VideoConductor from server code. Default draft mode uses grok-imagine-video @ 480p (~$0.05/second) for cheap text-to-video iteration. Set remaster: true for 720p finals, or pass sourceVideoUrl for scene-preserving edit/remaster via xAI's video edits API. First-frame stills and branded thumbnails compose automatically through ImageConductor and the scripted media pipeline.

    VideoConductor — end-to-end flow

    Developer reference

    Quality modes, MCP payloads, CLI manifests, and xAI model truth table.

    ImageConductor

    First-frame stills and shared xAI credentials for I2V scenes.

    Viral video CLI

    Scripted JSON requests, manifest v2, and run-scripted-video.mjs.

    ring-video-create MCP

    Tool reference, request fields, and gateway examples.

    What VideoConductor does

    CapabilityDetail
    Text-to-video (T2V)grok-imagine-video — montages, UI demos, vague dialogue
    Image-to-video (I2V)grok-imagine-video-1.5 — requires imageUrl; prompt drives motion and implied dialogue
    Draft iteration480p presets — minimize cost while scripting scenes
    Production remaster720p re-generate or edit pass on an existing MP4 URL
    First-frame automationfirstFramePrompt → ImageConductor when imageUrl is absent
    Thumbnail overlaysOptional thumbnail spec — text on first frame via lib/media/thumbnail
    Persistencering-filebase CDN URL + generated_videos JSONB ledger
    Pipeline audit, , , for multi-clip campaigns
    Conductor pattern

    VideoConductor mirrors PaymentConductor and ImageConductor: a single facade (lib/video/conductor/video-conductor.ts), provider adapters, config from env + lib/video/video-presets.json, and one PostgreSQL collection for the audit trail.

    Quality modes

    SSOT: lib/video/video-presets.json. Effective mode is resolved by resolveEffectiveQualityMode() — passing imageUrl on a draft request auto-upgrades to draft_i2v.

    qualityModeModelResolution~$/secNeeds imageUrl
    draft (default)grok-imagine-video480p$0.05No (T2V)
    draft_i2vgrok-imagine-video-1.5480p$0.08Yes
    productiongrok-imagine-video720p$0.05No
    production_i2vgrok-imagine-video-1.5720p$0.14Yes
    Model truth

    grok-imagine-video-1.5 is not text-only T2V — it requires a starting frame (imageUrl or auto-generated via firstFramePrompt). The text prompt controls motion and implied dialogue. For word-perfect spoken lines, burn VO in post or use the scripted pipeline's DIALOGUE: blocks as best-effort guidance only.

    Environment variables

    From env.local.template — reuse XAI_API_KEY from ImageConductor:

    Security

    Never commit XAI_API_KEY or RING_MCP_SERVICE_TOKENS to the repository. MCP routes are bearer-gated via withMcpGuard.

    Architecture

    VideoConductor module graph

    Response shape

    Successful jobs return GenerateVideoResult:

    FieldDescription
    video.urlPermanent CDN URL (when persisted) or temporary xAI URL
    video.temporaryUrlOriginal xAI download link (expires)
    video.requestIdxAI job id — use for audit and remaster chains
    video.recordIdgenerated_videos row id
    firstFrameImageConductor asset when firstFramePrompt was used
    thumbnailRendered thumbnail when thumbnail.enabled
    estimatedCostUsdduration × preset rate estimate
    qualityMode / resolutionEffective preset after auto-upgrade

    Moderation failures return success: false when xAI sets respect_moderation: false.

    Release history

    DateMilestone
    2026-06-09ImageConductor — generated_images ledger, ring-image-create MCP
    2026-06-18VideoConductor v1 — draft/production T2V, ring-video-create MCP, manifest v2
    2026-06-18I2V modes — draft_i2v / production_i2v, firstFramePrompt, sourceVideoUrl edit remaster
    2026-06-19Migration 018 — generated_videos on dev + prod; BackendSelector routes

    Related

    • Generative videos (developer) — CLI examples, model pricing table, legacy generate-xai-videos.mjs
    • Generative images — shared xAI block and first-frame generation
    • Documentation components — MDX widget reference for authoring

    VideoConductor

    VideoConductor is Ring Platform's async generative video layer — the video counterpart to ImageConductor. It polls xAI Grok Imagine Video, optionally uploads MP4s to ring-filebase, and records an audit row in PostgreSQL generated_videos.

    Executive summary

    Operators and agents call ring-video-create (MCP) or VideoConductor from server code. Default draft mode uses grok-imagine-video @ 480p (~$0.05/second) for cheap text-to-video iteration. Set remaster: true for 720p finals, or pass sourceVideoUrl for scene-preserving edit/remaster via xAI's video edits API. First-frame stills and branded thumbnails compose automatically through ImageConductor and the scripted media pipeline.

    VideoConductor — end-to-end flow

    Developer reference

    Quality modes, MCP payloads, CLI manifests, and xAI model truth table.

    ImageConductor

    First-frame stills and shared xAI credentials for I2V scenes.

    Viral video CLI

    Scripted JSON requests, manifest v2, and run-scripted-video.mjs.

    ring-video-create MCP

    Tool reference, request fields, and gateway examples.

    What VideoConductor does

    CapabilityDetail
    Text-to-video (T2V)grok-imagine-video — montages, UI demos, vague dialogue
    Image-to-video (I2V)grok-imagine-video-1.5 — requires imageUrl; prompt drives motion and implied dialogue
    Draft iteration480p presets — minimize cost while scripting scenes
    Production remaster720p re-generate or edit pass on an existing MP4 URL
    First-frame automationfirstFramePrompt → ImageConductor when imageUrl is absent
    Thumbnail overlaysOptional thumbnail spec — text on first frame via lib/media/thumbnail
    Persistencering-filebase CDN URL + generated_videos JSONB ledger
    Pipeline audit, , , for multi-clip campaigns
    Conductor pattern

    VideoConductor mirrors PaymentConductor and ImageConductor: a single facade (lib/video/conductor/video-conductor.ts), provider adapters, config from env + lib/video/video-presets.json, and one PostgreSQL collection for the audit trail.

    Quality modes

    SSOT: lib/video/video-presets.json. Effective mode is resolved by resolveEffectiveQualityMode() — passing imageUrl on a draft request auto-upgrades to draft_i2v.

    qualityModeModelResolution~$/secNeeds imageUrl
    draft (default)grok-imagine-video480p$0.05No (T2V)
    draft_i2vgrok-imagine-video-1.5480p$0.08Yes
    productiongrok-imagine-video720p$0.05No
    production_i2vgrok-imagine-video-1.5720p$0.14Yes
    Model truth

    grok-imagine-video-1.5 is not text-only T2V — it requires a starting frame (imageUrl or auto-generated via firstFramePrompt). The text prompt controls motion and implied dialogue. For word-perfect spoken lines, burn VO in post or use the scripted pipeline's DIALOGUE: blocks as best-effort guidance only.

    Environment variables

    From env.local.template — reuse XAI_API_KEY from ImageConductor:

    Security

    Never commit XAI_API_KEY or RING_MCP_SERVICE_TOKENS to the repository. MCP routes are bearer-gated via withMcpGuard.

    Architecture

    VideoConductor module graph

    Response shape

    Successful jobs return GenerateVideoResult:

    FieldDescription
    video.urlPermanent CDN URL (when persisted) or temporary xAI URL
    video.temporaryUrlOriginal xAI download link (expires)
    video.requestIdxAI job id — use for audit and remaster chains
    video.recordIdgenerated_videos row id
    firstFrameImageConductor asset when firstFramePrompt was used
    thumbnailRendered thumbnail when thumbnail.enabled
    estimatedCostUsdduration × preset rate estimate
    qualityMode / resolutionEffective preset after auto-upgrade

    Moderation failures return success: false when xAI sets respect_moderation: false.

    Release history

    DateMilestone
    2026-06-09ImageConductor — generated_images ledger, ring-image-create MCP
    2026-06-18VideoConductor v1 — draft/production T2V, ring-video-create MCP, manifest v2
    2026-06-18I2V modes — draft_i2v / production_i2v, firstFramePrompt, sourceVideoUrl edit remaster
    2026-06-19Migration 018 — generated_videos on dev + prod; BackendSelector routes

    Related

    • Generative videos (developer) — CLI examples, model pricing table, legacy generate-xai-videos.mjs
    • Generative images — shared xAI block and first-frame generation
    • Documentation components — MDX widget reference for authoring

    VideoConductor

    VideoConductor is Ring Platform's async generative video layer — the video counterpart to ImageConductor. It polls xAI Grok Imagine Video, optionally uploads MP4s to ring-filebase, and records an audit row in PostgreSQL generated_videos.

    Executive summary

    Operators and agents call ring-video-create (MCP) or VideoConductor from server code. Default draft mode uses grok-imagine-video @ 480p (~$0.05/second) for cheap text-to-video iteration. Set remaster: true for 720p finals, or pass sourceVideoUrl for scene-preserving edit/remaster via xAI's video edits API. First-frame stills and branded thumbnails compose automatically through ImageConductor and the scripted media pipeline.

    VideoConductor — end-to-end flow

    Developer reference

    Quality modes, MCP payloads, CLI manifests, and xAI model truth table.

    ImageConductor

    First-frame stills and shared xAI credentials for I2V scenes.

    Viral video CLI

    Scripted JSON requests, manifest v2, and run-scripted-video.mjs.

    ring-video-create MCP

    Tool reference, request fields, and gateway examples.

    What VideoConductor does

    CapabilityDetail
    Text-to-video (T2V)grok-imagine-video — montages, UI demos, vague dialogue
    Image-to-video (I2V)grok-imagine-video-1.5 — requires imageUrl; prompt drives motion and implied dialogue
    Draft iteration480p presets — minimize cost while scripting scenes
    Production remaster720p re-generate or edit pass on an existing MP4 URL
    First-frame automationfirstFramePrompt → ImageConductor when imageUrl is absent
    Thumbnail overlaysOptional thumbnail spec — text on first frame via lib/media/thumbnail
    Persistencering-filebase CDN URL + generated_videos JSONB ledger
    Pipeline audit, , , for multi-clip campaigns
    Conductor pattern

    VideoConductor mirrors PaymentConductor and ImageConductor: a single facade (lib/video/conductor/video-conductor.ts), provider adapters, config from env + lib/video/video-presets.json, and one PostgreSQL collection for the audit trail.

    Quality modes

    SSOT: lib/video/video-presets.json. Effective mode is resolved by resolveEffectiveQualityMode() — passing imageUrl on a draft request auto-upgrades to draft_i2v.

    qualityModeModelResolution~$/secNeeds imageUrl
    draft (default)grok-imagine-video480p$0.05No (T2V)
    draft_i2vgrok-imagine-video-1.5480p$0.08Yes
    productiongrok-imagine-video720p$0.05No
    production_i2vgrok-imagine-video-1.5720p$0.14Yes
    Model truth

    grok-imagine-video-1.5 is not text-only T2V — it requires a starting frame (imageUrl or auto-generated via firstFramePrompt). The text prompt controls motion and implied dialogue. For word-perfect spoken lines, burn VO in post or use the scripted pipeline's DIALOGUE: blocks as best-effort guidance only.

    Environment variables

    From env.local.template — reuse XAI_API_KEY from ImageConductor:

    Security

    Never commit XAI_API_KEY or RING_MCP_SERVICE_TOKENS to the repository. MCP routes are bearer-gated via withMcpGuard.

    Architecture

    VideoConductor module graph

    Response shape

    Successful jobs return GenerateVideoResult:

    FieldDescription
    video.urlPermanent CDN URL (when persisted) or temporary xAI URL
    video.temporaryUrlOriginal xAI download link (expires)
    video.requestIdxAI job id — use for audit and remaster chains
    video.recordIdgenerated_videos row id
    firstFrameImageConductor asset when firstFramePrompt was used
    thumbnailRendered thumbnail when thumbnail.enabled
    estimatedCostUsdduration × preset rate estimate
    qualityMode / resolutionEffective preset after auto-upgrade

    Moderation failures return success: false when xAI sets respect_moderation: false.

    Release history

    DateMilestone
    2026-06-09ImageConductor — generated_images ledger, ring-image-create MCP
    2026-06-18VideoConductor v1 — draft/production T2V, ring-video-create MCP, manifest v2
    2026-06-18I2V modes — draft_i2v / production_i2v, firstFramePrompt, sourceVideoUrl edit remaster
    2026-06-19Migration 018 — generated_videos on dev + prod; BackendSelector routes

    Related

    • Generative videos (developer) — CLI examples, model pricing table, legacy generate-xai-videos.mjs
    • Generative images — shared xAI block and first-frame generation
    • Documentation components — MDX widget reference for authoring
    clipId
    pipelineRequestId
    refCode
    actorId
    clipId
    pipelineRequestId
    refCode
    actorId
    clipId
    pipelineRequestId
    refCode
    actorId