Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
228 changes: 11 additions & 217 deletions docs/guides/captions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import Figure from '@site/src/components/Figure';
Eden's Captions.ai integration allows you to programmatically create AI-generated videos with custom avatars, voices, and scripts. This enables automated video content creation, personalized messaging, and scalable video production through Eden's AI-powered tools.
:::

:::warning Paid Features!
Captions API requires a credit balance on Captions.ai - as a new account, you will receive 360 credits for generation. For more info read their docs [here](https://help.captions.ai/api-reference/api#can-i-use-the-same-api-key-for-different-applications)
:::

## Prerequisites

Before setting up Captions.ai integration, you'll need:
Expand All @@ -27,228 +31,18 @@ Before setting up Captions.ai integration, you'll need:
1. **Sign Up for Captions.ai**

- Go to [captions.ai](https://captions.ai)
- Click **Sign Up** and create your account
- Click **Get Started**
- Sign up as appropriate
- Verify your email address

2. **Complete Your Profile**
- Fill in your account information
- Set up your payment method if needed
- Complete any required verification steps

### Step 2: Generate API Key

1. **Access API Settings**

- Log into your Captions.ai dashboard
- Go to **Settings** → **API Keys**
- Click **Generate API Key**

2. **Configure API Permissions**

- Select the following permissions for your API key:
- **Video Generation**: Create and manage videos
- **AI Clones**: Access and manage your AI clones
- **Scripts**: Upload and manage scripts
- **Media**: Upload and manage media files

3. **Generate and Copy Key**
- Click **Generate Key**
- **Copy the API key immediately** - you won't be able to see it again
- Store it securely for use in your environment variables

## Creating Your AI Clone

### Step 1: Prepare Your Media

1. **Photo Requirements**

- Use high-quality, well-lit photos
- Include multiple angles of your face
- Ensure good contrast and clear features
- Avoid sunglasses, hats, or heavy makeup
- Use photos with neutral expressions

2. **Video Requirements (Optional)**
- Record 30-60 seconds of clear speech
- Use good lighting and audio quality
- Speak naturally and clearly
- Avoid background noise
- Include various facial expressions

### Step 2: Upload Media for AI Clone

1. **Access Clone Creation**

- In your Captions.ai dashboard, go to **AI Clones**
- Click **Create New Clone**
- Choose between photo-based or video-based cloning

2. **Upload Your Media**

- Upload 10-20 high-quality photos
- Or upload a video file (MP4, MOV format)
- Ensure files meet size and format requirements
- Wait for processing to complete

3. **Configure Clone Settings**
- Set your clone's name and description
- Choose voice settings if applicable
- Configure personality traits
- Set privacy and usage permissions

### Step 3: Train Your AI Clone

1. **Start Training Process**

- Click **Start Training** to begin AI clone creation
- Training typically takes 15-30 minutes
- You'll receive a notification when complete

2. **Test Your Clone**

- Generate a test video with your clone
- Verify facial features and expressions
- Check voice quality and synchronization
- Make adjustments if needed

3. **Save Clone ID**
- Note your clone's unique ID
- This will be used in API calls for video generation

## Best Practices for Scripts and Media

### Script Best Practices

1. **Script Structure**

- Keep scripts concise and engaging
- Use natural, conversational language
- Include clear pauses and emphasis points
- Avoid complex technical jargon
- Structure with clear beginning, middle, and end

2. **Content Guidelines**

- Write for your target audience
- Include calls-to-action when appropriate
- Use active voice and present tense
- Keep sentences short and punchy
- Include emotional hooks and storytelling elements

3. **Technical Considerations**
- Aim for 15-60 second videos for best results
- Include timing markers for complex scripts
- Specify emphasis and tone changes
- Use phonetic spellings for difficult words
- Include breathing pauses for natural flow

### Media Best Practices

1. **Background Media**

- Use high-resolution images or videos
- Ensure media is relevant to your content
- Avoid copyrighted material
- Use consistent aspect ratios (16:9 recommended)
- Include variety for visual interest

2. **Audio Considerations**

- Use royalty-free music when adding background audio
- Ensure audio levels are appropriate
- Consider adding sound effects for engagement
- Test audio quality before final generation

3. **Brand Consistency**
- Use consistent colors and fonts
- Include your logo or branding elements
- Maintain visual style across videos
- Consider creating templates for recurring content

## Environment Variables Configuration

Once you have your credentials, configure the following environment variables:

```bash
# Captions API Configuration
# Get your API key from: https://help.captions.ai/api-reference/api
CAPTIONS_API_KEY=your-api-key-here # Deployment specific

# Optional: Default settings
DEFAULT_VIDEO_DURATION=30
DEFAULT_VIDEO_STYLE=professional
DEFAULT_OUTPUT_DIR=./generated_videos
```

### Variable Descriptions

- **`CAPTIONS_API_KEY`**: Your Captions.ai API key for authentication
- **`DEFAULT_VIDEO_DURATION`**: Default video length in seconds (optional)
- **`DEFAULT_VIDEO_STYLE`**: Default video style/theme (optional)
- **`DEFAULT_OUTPUT_DIR`**: Default directory for generated videos (optional)

## Complete Workflow Integration

Eden's Captions.ai integration is designed to work seamlessly with other platforms in a complete content creation and distribution pipeline:

### Step 1: Generate Script

- Use Eden's AI tools to create engaging video scripts
- Optimize scripts for your target audience and platform
- Include calls-to-action and brand messaging

### Step 2: Create Product & Media

- Generate product designs using Eden's creative tools
- Create products on [Printify](/docs/guides/printify) or [Shopify](/docs/guides/shopify)
- Extract product images and media for video background

### Step 3: Prepare Video Assets

- Use the generated product media as video backgrounds
- Ensure media meets Captions.ai requirements (high resolution, proper aspect ratios)
- Organize assets for batch processing

### Step 4: Generate Video with Captions.ai

- Send script + product media to Captions.ai API
- Use your trained AI clone for consistent branding
- Configure video settings (duration, style, format)

### Step 5: Retrieve and Process Video

- Download generated video from Captions.ai
- Apply any final edits or branding overlays
- Optimize for different platform requirements

### Step 6: Distribute to Social Channels

- Upload to Instagram (Reels, Stories, Posts)
- Post to TikTok with trending hashtags
- Share on X (Twitter) with engaging captions
- Cross-post to Farcaster and other Web3 platforms

### Workflow Automation Tips

1. **Batch Processing**

- Generate multiple scripts and products simultaneously
- Use templates for consistent formatting
- Set up automated scheduling for social posts

2. **Platform Optimization**

- Create different video formats for each platform
- Optimize aspect ratios (9:16 for TikTok/Reels, 16:9 for YouTube)
- Adjust video length based on platform best practices

3. **Content Strategy**

- Maintain consistent branding across all videos
- Use product media to showcase your offerings
- Include platform-specific calls-to-action
- Go to **API Dashboard**
- Click **Generate API Key** - follow the Terms and Conditions
- Copy the API key to clipboard
- Add the API key to your Agents Captions deployment

4. **Analytics and Iteration**
- Track performance across different platforms
- A/B test different scripts and media combinations
- Refine your AI clone based on performance data
<Figure src="/img/captions/api.png" caption="Captions copy API key" width="50%" />
Loading