Documentation

    Documentation

    Documentation

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    1. /
    2. /Scripted Media Pipeline

    Updated Jun 18, 20262 min listen

    1. /
    2. /Scripted Media Pipeline

    Updated Jun 18, 20262 min listen

    1. /
    2. /Scripted Media Pipeline

    Updated Jun 18, 20262 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
    Development
    Docs
    Development
    Docs
    Development

    Scripted Media Pipeline (Ring Media Conductor)

    Provider-neutral, schema-driven pipeline for marketing and explainer reels. A creative agent authors one scripted-video-generation-request-<id>.json; ring-video-create chains:

    1. First-frame still (firstFramePrompt → ImageConductor)
    2. I2V video (grok-imagine-video-1.5 @ 480p when draft + image)
    3. Optional thumbnail (deterministic text overlays via next/og)

    ring-video-create

    MCP tool reference (overloaded scene path).

    Generative videos

    VideoConductor presets and remaster modes.

    Architecture

    ArtifactPath
    JSON Schemalib/media/scripted-video-generation.schema.json
    Zod validationlib/media/schemas.ts
    Prompt compilerlib/media/prompt-compiler.ts
    Thumbnaillib/media/thumbnail.tsx
    Example requestscripts/ring-viral-video/scripted-video-generation-request-hoa-nightclub.json
    CLI runnerscripts/ring-viral-video/run-scripted-video.mjs
    Director lensAI-LEGIOX/legiox-truth-lens/scripted-video-director.nodus.json

    Request file shape

    Cast placeholders: {{guy}}, {{girl}} resolve to cast[].description at compile time.

    Clip types

    TypefirstFramescene.dialogueVideo mode
    Montage / UIomitoptionalT2V grok-imagine-video @ 480p
    DialogueimagePrompt requiredrequiredI2V grok-imagine-video-1.5 @ 480p

    CLI

    Manifest v3 tracks firstFrameUrl, thumbnailUrl, pipelineRequestId, clipId per upsert key id::qualityMode.

    MCP (single clip)

    With thumbnail.enabled in body — see ring-video-create.

    Agent workflow

    Consult scripted-video-director truth lens when authoring requests. Validate with:

    Environment

    Legacy

    xai-video-jobs.json + generate-xai-videos.mjs remain for direct xAI batch runs without gateway. Prefer the scripted request file for new campaigns.

    Scripted Media Pipeline (Ring Media Conductor)

    Provider-neutral, schema-driven pipeline for marketing and explainer reels. A creative agent authors one scripted-video-generation-request-<id>.json; ring-video-create chains:

    1. First-frame still (firstFramePrompt → ImageConductor)
    2. I2V video (grok-imagine-video-1.5 @ 480p when draft + image)
    3. Optional thumbnail (deterministic text overlays via next/og)

    ring-video-create

    MCP tool reference (overloaded scene path).

    Generative videos

    VideoConductor presets and remaster modes.

    Architecture

    ArtifactPath
    JSON Schemalib/media/scripted-video-generation.schema.json
    Zod validationlib/media/schemas.ts
    Prompt compilerlib/media/prompt-compiler.ts
    Thumbnaillib/media/thumbnail.tsx
    Example requestscripts/ring-viral-video/scripted-video-generation-request-hoa-nightclub.json
    CLI runnerscripts/ring-viral-video/run-scripted-video.mjs
    Director lensAI-LEGIOX/legiox-truth-lens/scripted-video-director.nodus.json

    Request file shape

    Cast placeholders: {{guy}}, {{girl}} resolve to cast[].description at compile time.

    Clip types

    TypefirstFramescene.dialogueVideo mode
    Montage / UIomitoptionalT2V grok-imagine-video @ 480p
    DialogueimagePrompt requiredrequiredI2V grok-imagine-video-1.5 @ 480p

    CLI

    Manifest v3 tracks firstFrameUrl, thumbnailUrl, pipelineRequestId, clipId per upsert key id::qualityMode.

    MCP (single clip)

    With thumbnail.enabled in body — see ring-video-create.

    Agent workflow

    Consult scripted-video-director truth lens when authoring requests. Validate with:

    Environment

    Legacy

    xai-video-jobs.json + generate-xai-videos.mjs remain for direct xAI batch runs without gateway. Prefer the scripted request file for new campaigns.

    Scripted Media Pipeline (Ring Media Conductor)

    Provider-neutral, schema-driven pipeline for marketing and explainer reels. A creative agent authors one scripted-video-generation-request-<id>.json; ring-video-create chains:

    1. First-frame still (firstFramePrompt → ImageConductor)
    2. I2V video (grok-imagine-video-1.5 @ 480p when draft + image)
    3. Optional thumbnail (deterministic text overlays via next/og)

    ring-video-create

    MCP tool reference (overloaded scene path).

    Generative videos

    VideoConductor presets and remaster modes.

    Architecture

    ArtifactPath
    JSON Schemalib/media/scripted-video-generation.schema.json
    Zod validationlib/media/schemas.ts
    Prompt compilerlib/media/prompt-compiler.ts
    Thumbnaillib/media/thumbnail.tsx
    Example requestscripts/ring-viral-video/scripted-video-generation-request-hoa-nightclub.json
    CLI runnerscripts/ring-viral-video/run-scripted-video.mjs
    Director lensAI-LEGIOX/legiox-truth-lens/scripted-video-director.nodus.json

    Request file shape

    Cast placeholders: {{guy}}, {{girl}} resolve to cast[].description at compile time.

    Clip types

    TypefirstFramescene.dialogueVideo mode
    Montage / UIomitoptionalT2V grok-imagine-video @ 480p
    DialogueimagePrompt requiredrequiredI2V grok-imagine-video-1.5 @ 480p

    CLI

    Manifest v3 tracks firstFrameUrl, thumbnailUrl, pipelineRequestId, clipId per upsert key id::qualityMode.

    MCP (single clip)

    With thumbnail.enabled in body — see ring-video-create.

    Agent workflow

    Consult scripted-video-director truth lens when authoring requests. Validate with:

    Environment

    Legacy

    xai-video-jobs.json + generate-xai-videos.mjs remain for direct xAI batch runs without gateway. Prefer the scripted request file for new campaigns.

    json
    
    {
      "schemaVersion": "1.0",
      "requestId": "hoa-nightclub-viral-2026-06",
      "purpose": "viral-ad",
      "defaults": { "qualityMode": "draft", "aspectRatio": "16:9", "imageResolution": "2k" },
      "cast": [{ "id": "guy", "description": "…" }],
      "setting": "San Francisco nightclub at night…",
      "clips": [{
        "id": "03_sf_nightclub_ring_opener",
        "duration": 12,
        "firstFrame": { "imagePrompt": "{{girl}} and {{guy}} at bar…" },
        "scene": {
          "action": "{{guy}} gestures warmly…",
          "dialogue": [{ "speaker": "guy", "line": "So your HOA uses Ring?", "tone": "warmly" }]
        },
        "thumbnail": { "enabled": true, "overlays": [{ "text": "Your HOA on Ring", "role": "title" }] }
      }]
    }
    bash
    
    cd ring-platform.org/scripts/ring-viral-video
    
    # Full pipeline via MCP gateway (needs RING_MCP_SERVICE_TOKENS + dev server)
    node run-scripted-video.mjs scripted-video-generation-request-hoa-nightclub.json --download
    
    # Single clip
    node run-scripted-video.mjs scripted-video-generation-request-hoa-nightclub.json --clip=03_sf_nightclub_ring_opener
    
    # Remaster from manifest URL
    node run-scripted-video.mjs request.json --remaster --clip=03_sf_nightclub_ring_opener --source-url=https://...
    typescript
    
    import { scriptedVideoGenerationRequestSchema } from '@/lib/media/schemas'
    scriptedVideoGenerationRequestSchema.parse(request)
    bash
    
    XAI_API_KEY=…
    RING_MCP_SERVICE_TOKENS=long-random-token
    RING_API_BASE_URL=http://localhost:3000
    FILE_BACKEND=ringbase
    text
    
    Creative agent → scripted-video-generation-request.json
      → run-scripted-video.mjs (CLI) OR ring-video-create (MCP)
        → VideoConductor.generate
          → ImageConductor (firstFramePrompt)
          → xAI I2V (compiled ACTION/DIALOGUE prompt)
          → thumbnail compositor (optional)
        → manifest v3 + ring-filebase URLs
    text
    
    ring-video-create \
      prompt "ACTION: … DIALOGUE: …" \
      firstFramePrompt "Cinematic still {{guy}} and {{girl}} at bar…" \
      qualityMode draft duration 12 purpose viral-ad clipId 03_sf_nightclub_ring_opener
    json
    
    {
      "schemaVersion": "1.0",
      "requestId": "hoa-nightclub-viral-2026-06",
      "purpose": "viral-ad",
      "defaults": { "qualityMode": "draft", "aspectRatio": "16:9", "imageResolution": "2k" },
      "cast": [{ "id": "guy", "description": "…" }],
      "setting": "San Francisco nightclub at night…",
      "clips": [{
        "id": "03_sf_nightclub_ring_opener",
        "duration": 12,
        "firstFrame": { "imagePrompt": "{{girl}} and {{guy}} at bar…" },
        "scene": {
          "action": "{{guy}} gestures warmly…",
          "dialogue": [{ "speaker": "guy", "line": "So your HOA uses Ring?", "tone": "warmly" }]
        },
        "thumbnail": { "enabled": true, "overlays": [{ "text": "Your HOA on Ring", "role": "title" }] }
      }]
    }
    bash
    
    cd ring-platform.org/scripts/ring-viral-video
    
    # Full pipeline via MCP gateway (needs RING_MCP_SERVICE_TOKENS + dev server)
    node run-scripted-video.mjs scripted-video-generation-request-hoa-nightclub.json --download
    
    # Single clip
    node run-scripted-video.mjs scripted-video-generation-request-hoa-nightclub.json --clip=03_sf_nightclub_ring_opener
    
    # Remaster from manifest URL
    node run-scripted-video.mjs request.json --remaster --clip=03_sf_nightclub_ring_opener --source-url=https://...
    typescript
    
    import { scriptedVideoGenerationRequestSchema } from '@/lib/media/schemas'
    scriptedVideoGenerationRequestSchema.parse(request)
    bash
    
    XAI_API_KEY=…
    RING_MCP_SERVICE_TOKENS=long-random-token
    RING_API_BASE_URL=http://localhost:3000
    FILE_BACKEND=ringbase
    text
    
    Creative agent → scripted-video-generation-request.json
      → run-scripted-video.mjs (CLI) OR ring-video-create (MCP)
        → VideoConductor.generate
          → ImageConductor (firstFramePrompt)
          → xAI I2V (compiled ACTION/DIALOGUE prompt)
          → thumbnail compositor (optional)
        → manifest v3 + ring-filebase URLs
    text
    
    ring-video-create \
      prompt "ACTION: … DIALOGUE: …" \
      firstFramePrompt "Cinematic still {{guy}} and {{girl}} at bar…" \
      qualityMode draft duration 12 purpose viral-ad clipId 03_sf_nightclub_ring_opener
    json
    
    {
      "schemaVersion": "1.0",
      "requestId": "hoa-nightclub-viral-2026-06",
      "purpose": "viral-ad",
      "defaults": { "qualityMode": "draft", "aspectRatio": "16:9", "imageResolution": "2k" },
      "cast": [{ "id": "guy", "description": "…" }],
      "setting": "San Francisco nightclub at night…",
      "clips": [{
        "id": "03_sf_nightclub_ring_opener",
        "duration": 12,
        "firstFrame": { "imagePrompt": "{{girl}} and {{guy}} at bar…" },
        "scene": {
          "action": "{{guy}} gestures warmly…",
          "dialogue": [{ "speaker": "guy", "line": "So your HOA uses Ring?", "tone": "warmly" }]
        },
        "thumbnail": { "enabled": true, "overlays": [{ "text": "Your HOA on Ring", "role": "title" }] }
      }]
    }
    bash
    
    cd ring-platform.org/scripts/ring-viral-video
    
    # Full pipeline via MCP gateway (needs RING_MCP_SERVICE_TOKENS + dev server)
    node run-scripted-video.mjs scripted-video-generation-request-hoa-nightclub.json --download
    
    # Single clip
    node run-scripted-video.mjs scripted-video-generation-request-hoa-nightclub.json --clip=03_sf_nightclub_ring_opener
    
    # Remaster from manifest URL
    node run-scripted-video.mjs request.json --remaster --clip=03_sf_nightclub_ring_opener --source-url=https://...
    typescript
    
    import { scriptedVideoGenerationRequestSchema } from '@/lib/media/schemas'
    scriptedVideoGenerationRequestSchema.parse(request)
    bash
    
    XAI_API_KEY=…
    RING_MCP_SERVICE_TOKENS=long-random-token
    RING_API_BASE_URL=http://localhost:3000
    FILE_BACKEND=ringbase
    text
    
    Creative agent → scripted-video-generation-request.json
      → run-scripted-video.mjs (CLI) OR ring-video-create (MCP)
        → VideoConductor.generate
          → ImageConductor (firstFramePrompt)
          → xAI I2V (compiled ACTION/DIALOGUE prompt)
          → thumbnail compositor (optional)
        → manifest v3 + ring-filebase URLs
    text
    
    ring-video-create \
      prompt "ACTION: … DIALOGUE: …" \
      firstFramePrompt "Cinematic still {{guy}} and {{girl}} at bar…" \
      qualityMode draft duration 12 purpose viral-ad clipId 03_sf_nightclub_ring_opener