diff --git a/docs/guides/captions.md b/docs/guides/captions.md index 06bf2d6..5432cbc 100644 --- a/docs/guides/captions.md +++ b/docs/guides/captions.md @@ -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: @@ -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 +
diff --git a/docs/guides/printify.md b/docs/guides/printify.md index da6f4e4..7884e41 100644 --- a/docs/guides/printify.md +++ b/docs/guides/printify.md @@ -10,13 +10,17 @@ import Figure from '@site/src/components/Figure'; Eden's Printify integration allows you to programmatically create and manage print-on-demand products through Printify's network of print providers. This enables automated product creation, design management, and fulfillment through Eden's AI-powered tools. ::: +:::warning Note +Printify is a drop-shipping service and will use its own connection to Shopify. This replaces the Eden Shopify integration. The Eden Shopify integration is best suited for physical goods where you have the inventory on-hand and wish to sell them via your Agent. +::: + ## Prerequisites Before setting up Printify integration, you'll need: - A Printify account (free to create) - Access to Printify's Merchant Dashboard -- Basic understanding of print-on-demand products +- Basic understanding of print-on-demand products & the Printify platform - A connected sales channel (Shopify, WooCommerce, etc.) for selling products ## Getting Your Printify Credentials @@ -29,98 +33,44 @@ Before setting up Printify integration, you'll need: - Click **Sign Up** and create your account - Verify your email address -2. **Complete Your Profile** +2. **Complete Setup** - Fill in your business information - Set up your payment method - - Complete any required verification steps + - Connect your sales channel. See warning above if this is Shopify. + - Complete any required verification & information steps ### Step 2: Generate API Token 1. **Access API Settings** - Log into your Printify Merchant Dashboard - - Go to **Settings** → **API Keys** - - Click **Generate API Key** - -2. **Configure API Permissions** - - - Select the following permissions for your API key: - - **Shops**: Read and Write access - - **Catalog**: Read access - - **Orders**: Read and Write access - - **Products**: Read and Write access - - **Webhooks**: Read and Write access - - **Uploads**: Read and Write access - - **Print Providers**: Read access - - **User Info**: Read access - -3. **Generate and Copy Token** - - Click **Generate Key** - - **Copy the API token immediately** - you won't be able to see it again - - Store it securely for use in your environment variables - -### Step 3: Get Your Shop ID - -1. **Find Your Shop ID** - - - In your Printify dashboard, go to **Shops** - - Click on your shop name - - The Shop ID will be displayed in the URL or shop settings - - It's a numeric value (e.g., `23694293`) - -2. **Note Your Shop Details** - - Keep track of your shop name and ID - - Ensure your shop is properly configured with a sales channel - -## Linking Printify to Shopify - -To enable seamless product creation and order fulfillment, you need to connect your Printify store to your Shopify store: - -### Step 1: Connect Sales Channel - -1. **Add Shopify as Sales Channel** - - - In your Printify dashboard, go to **Shops** - - Click **Add sales channel** - - Select **Shopify** from the list of available platforms - -2. **Connect Your Shopify Store** - - - Click **Connect** next to Shopify - - You'll be redirected to Shopify to authorize the connection - - Log into your Shopify admin if prompted - - Click **Install app** to allow Printify access to your store - -3. **Configure Connection Settings** - - Set your preferred sync settings for products and orders - - Choose whether to sync inventory automatically - - Configure shipping and tax settings - -### Step 2: Verify Connection + - Click the burger menu in the top right + - Scroll to **Account** dropdown, click + - Select **Connections** -1. **Check Connection Status** +
- - Return to your Printify dashboard - - Go to **Shops** → **Sales channels** - - Verify Shopify shows as "Connected" + - Go to **API tokens** + - Click **Generate** + - Select the following **Custom scopes**: `shops.read`, `catalog.read`, `products.read`, `products.write`, `uploads.write`, `print_providers.read` + - Click **Generate token** + - Click **Copy to clipboard** and add the API Key to your Eden deployment -2. **Test Product Sync** - - Create a test product in Printify - - Verify it appears in your Shopify store - - Check that product details sync correctly +
-### Step 3: Configure Sync Settings +### Step 2: Connect To Shopify -1. **Product Sync Settings** +1. **Connect** - - Choose which products to sync (all or selected) - - Set up automatic inventory updates - - Configure pricing and variant mapping + - Click the merchant icon next to the burger menu in the top right + - Scroll to Shopify, click **Connect to Shopify** + - Click **Continue** + - If you need to create a Shopify, follow **1. Create your Shopify account** otherwise use **2. Connect it with Printify** + - Enter your store URL in to the input and click **Connect** (See Shopify guide if you need help finding your store URL) + - Click **Install** in the pop up window for the Printify: Print on Demand add on + - Once connected, close the tab and click **3. Complete the setup** -> **I've completed my setup** -2. **Order Sync Settings** - - Enable automatic order import from Shopify - - Set up fulfillment notifications - - Configure order status updates +
### Important Notes @@ -140,65 +90,10 @@ Printify products consist of: - **Design**: Your artwork or text that gets printed on the product - **Variants**: Different sizes, colors, or styles of the same product -### Step 1: Explore Available Products - -1. **Browse the Catalog** - - - Go to **Catalog** in your Printify dashboard - - Browse available products by category - - Note product IDs and available variants - -2. **Check Print Providers** - - Each product has specific print providers - - Different providers offer different quality, pricing, and shipping times - - Note which providers you prefer for different product types - -### Step 2: Create Product Templates - -1. **Design Your Template** - - - Use Printify's design tool or upload your own artwork - - Set up print areas and positioning - - Configure text overlays if needed - -2. **Save as Template** - - Save your design as a template for reuse - - Note the template ID for programmatic access - - Organize templates by product type or theme - -### Step 3: Configure Product Settings - -1. **Set Up Product Details** - - - Configure product titles and descriptions - - Set pricing and profit margins - - Configure shipping options - -2. **Set Up Variants** - - Configure available sizes, colors, and styles - - Set individual pricing for variants if needed - - Configure inventory tracking - -## Environment Variables Configuration - -Once you have your credentials, configure the following environment variables: - -```bash -# Printify API Configuration -PRINTIFY_API_TOKEN=your-api-token-here # Deployment specific - -PRINTIFY_SHOP_ID=your-shop-id-here # Deployment specific - -# Optional: Default path for product.json file -DEFAULT_PRODUCT_JSON_PATH=./product.json - -# Optional: Debug mode (set to 'true' to enable verbose logging) -DEBUG=false -``` +Your agent has access to Edens physical item & print provider template lists - and will be able to generate a product in accordance with these! Alternatively, you can browse the Printify catalog from your dashboard and ask for a specific item. ### Variable Descriptions - **`PRINTIFY_API_TOKEN`**: Your Printify API token with the required permissions -- **`PRINTIFY_SHOP_ID`**: The numeric ID of your Printify shop - **`DEFAULT_PRODUCT_JSON_PATH`**: Default path for product configuration files (optional) - **`DEBUG`**: Enable debug logging for troubleshooting (optional) diff --git a/docs/guides/shopify.md b/docs/guides/shopify.md index 02c3dce..fc3be0a 100644 --- a/docs/guides/shopify.md +++ b/docs/guides/shopify.md @@ -24,15 +24,20 @@ Before setting up Shopify integration, you'll need: 1. **Log into your Shopify Admin** - - Go to your Shopify store's admin panel + - Go to your Shopify store's admin panel. If you need to create a new shopify go to [https://accounts.shopify.com/](https://accounts.shopify.com/) and sign up as appropriate, then create a store - Navigate to **Settings** → **Apps and sales channels** 2. **Create a Private App** - Click on **Develop apps** (or **Manage private apps** for older stores) + - Click 'Allow custom app development' if not already selected + +
+ - Click **Create an app** - Give your app a name (e.g., "Eden Integration") - - Enter your email address as the developer email + - Select your email address as the developer email + - Click **Create app** 3. **Configure App Permissions** @@ -40,12 +45,12 @@ Before setting up Shopify integration, you'll need: - Enable the following permissions: - **Products**: `read_products`, `write_products` - **Inventory**: `read_inventory`, `write_inventory` - - **Product images**: `read_product_images`, `write_product_images` - - **Variants**: `read_product_variants`, `write_product_variants` + - **Locations**: `read_locations`, `write_locations` + - **Publications**: `read_publications`, `write_publications` - Click **Save** 4. **Install the App** - - Click **Install app** to install it on your store + - Click **Install app** to install it on your store. You may need to close the settings and reopen them for the button to enable. - Confirm the installation ### Step 2: Get Your Access Token @@ -56,69 +61,36 @@ After installing the app: - In your app's overview page, you'll see an **Admin API access token** - Click **Reveal token once** to see it - - **Copy this token immediately** - you won't be able to see it again + - **Copy this token immediately** - you won't be able to see it again. It should start with `shpat` 2. **Note Your Store Name** - Your store name is the subdomain of your Shopify store - For example, if your store URL is `mystore.myshopify.com`, your store name is `mystore` +
+ 3. **Get Your Location ID** + - Go to **Settings** → **Locations** - - You'll see a list of your store's locations (warehouses, retail stores, etc.) - - Note the **Location ID** for your primary location - - If you only have one location, this is typically your main warehouse or fulfillment center + - You'll see a list of your store's locations (warehouses, retail stores, etc.). For new stores this may just be 'Shop location' and then a country. + - Select a location + - Note the **Location ID** for your primary location. This is located at the end of the URL in your URL bar - The Location ID is a numeric value (e.g., `123456789`) -## Store Configuration - -### Required Store Settings - -Before using the integration, ensure your store is properly configured: - -1. **Enable API Access** - - - Go to **Settings** → **Apps and sales channels** - - Ensure your private app is listed and active - -2. **Configure Product Settings** - - - Go to **Settings** → **Products** - - Ensure **Inventory tracking** is enabled if you plan to manage inventory - - Set up your **Default product type** and **Default vendor** if desired - -3. **Set Up Payment Methods** - - - Go to **Settings** → **Payments** - - Ensure you have at least one payment method configured - -4. **Configure Shipping** - - Go to **Settings** → **Shipping and delivery** - - Set up shipping zones and rates - -## Environment Variables Configuration - -Once you have your credentials, configure the following environment variables: +
-```bash -# Shopify Configuration -# Replace these values with your actual Shopify store credentials +## Agent Deployment Configuration -# Your Shopify store name (without .myshopify.com) -SHOPIFY_STORE_NAME=your-store-name # Deployment specific +Once you have your credentials, configure the corresponding variables for your Eden agent deployment. -# Shopify API version (e.g., 2023-10, 2024-01) -SHOPIFY_API_VERSION=2025-07 # Does not need to change +
-# Your Shopify access token with product creation permissions -SHOPIFY_ACCESS_TOKEN=your-access-token-here # Deployment specific +## Use -# Your Shopify location ID for inventory management -SHOPIFY_LOCATION_ID=your-location-id-here # Deployment specific +Once you have deployed your Shopify configuration, prompt your Agent to create a Shopify product! -# Optional: Set to 'true' to enable debug logging -DEBUG=false # Does not need to change -``` +
### Variable Descriptions @@ -130,8 +102,6 @@ DEBUG=false # Does not need to change ## Security Best Practices -- **Keep your access token secure** - never commit it to version control -- **Use environment variables** - store credentials in secure environment variables - **Regularly rotate tokens** - regenerate your access token periodically - **Monitor API usage** - keep track of API calls to avoid rate limits - **Use minimal permissions** - only grant the permissions your integration needs diff --git a/package.json b/package.json index 64363f1..2e9d49a 100644 --- a/package.json +++ b/package.json @@ -44,5 +44,6 @@ }, "engines": { "node": ">=16.14" - } + }, + "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" } diff --git a/static/img/captions/api.png b/static/img/captions/api.png new file mode 100644 index 0000000..30a20a6 Binary files /dev/null and b/static/img/captions/api.png differ diff --git a/static/img/printify/connections.png b/static/img/printify/connections.png new file mode 100644 index 0000000..8846a24 Binary files /dev/null and b/static/img/printify/connections.png differ diff --git a/static/img/printify/scopes.png b/static/img/printify/scopes.png new file mode 100644 index 0000000..416b554 Binary files /dev/null and b/static/img/printify/scopes.png differ diff --git a/static/img/printify/shopify.png b/static/img/printify/shopify.png new file mode 100644 index 0000000..04185d2 Binary files /dev/null and b/static/img/printify/shopify.png differ diff --git a/static/img/shopify/agent-deployment.png b/static/img/shopify/agent-deployment.png new file mode 100644 index 0000000..e90bdcc Binary files /dev/null and b/static/img/shopify/agent-deployment.png differ diff --git a/static/img/shopify/app-dev.jpg b/static/img/shopify/app-dev.jpg new file mode 100644 index 0000000..1652563 Binary files /dev/null and b/static/img/shopify/app-dev.jpg differ diff --git a/static/img/shopify/product.png b/static/img/shopify/product.png new file mode 100644 index 0000000..df4890d Binary files /dev/null and b/static/img/shopify/product.png differ diff --git a/static/img/shopify/store-location.png b/static/img/shopify/store-location.png new file mode 100644 index 0000000..fcff453 Binary files /dev/null and b/static/img/shopify/store-location.png differ diff --git a/static/img/shopify/store-name.png b/static/img/shopify/store-name.png new file mode 100644 index 0000000..fa9e8e6 Binary files /dev/null and b/static/img/shopify/store-name.png differ