From 088aa78644a14b9aded7d5b1d392475436d4b15a Mon Sep 17 00:00:00 2001 From: henry <13052648+gitpancake@users.noreply.github.com> Date: Tue, 5 Aug 2025 17:55:47 -0700 Subject: [PATCH 1/5] Add Shopify docs --- docs/guides/shopify.md | 198 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 198 insertions(+) create mode 100644 docs/guides/shopify.md diff --git a/docs/guides/shopify.md b/docs/guides/shopify.md new file mode 100644 index 0000000..aefb83c --- /dev/null +++ b/docs/guides/shopify.md @@ -0,0 +1,198 @@ +--- +sidebar_position: 1 +--- + +import Figure from '@site/src/components/Figure'; + +# Shopify Integration Setup + +:::tip What is Shopify Integration? +Eden's Shopify integration allows you to programmatically create and manage products in your Shopify store. This enables automated product creation, inventory management, and store operations through Eden's AI-powered tools. +::: + +## Prerequisites + +Before setting up Shopify integration, you'll need: + +- A Shopify store (either a paid plan or Shopify Plus) +- Admin access to your Shopify store +- Basic understanding of Shopify's admin interface + +## Getting Your Shopify Credentials + +### Step 1: Create a Private App + +1. **Log into your Shopify Admin** + + - Go to your Shopify store's admin panel + - Navigate to **Settings** → **Apps and sales channels** + +2. **Create a Private App** + + - Click on **Develop apps** (or **Manage private apps** for older stores) + - Click **Create an app** + - Give your app a name (e.g., "Eden Integration") + - Enter your email address as the developer email + +3. **Configure App Permissions** + + - Click on **Configure Admin API scopes** + - 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` + - Click **Save** + +4. **Install the App** + - Click **Install app** to install it on your store + - Confirm the installation + +### Step 2: Get Your Access Token + +After installing the app: + +1. **Copy the Access Token** + + - 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 + +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 + - 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 + +# Your Shopify store name (without .myshopify.com) +SHOPIFY_STORE_NAME=your-store-name # Deployment specific + +# 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 + +# Your Shopify location ID for inventory management +SHOPIFY_LOCATION_ID=your-location-id-here # Deployment specific + +# Optional: Set to 'true' to enable debug logging +DEBUG=false # Does not need to change +``` + +### Variable Descriptions + +- **`SHOPIFY_STORE_NAME`**: Your store's subdomain (e.g., `mystore` for `mystore.myshopify.com`) +- **`SHOPIFY_API_VERSION`**: The Shopify API version to use (recommended: `2025-07`) +- **`SHOPIFY_ACCESS_TOKEN`**: The admin API access token from your private app +- **`SHOPIFY_LOCATION_ID`**: The numeric ID of your primary location for inventory management +- **`DEBUG`**: Enable debug logging for troubleshooting (optional) + +## Testing Your Integration + +After setting up your credentials: + +1. **Verify API Access** + + - Test a simple API call to ensure your credentials work + - Try fetching your store's product list + +2. **Create a Test Product** + + - Use Eden's tools to create a simple test product + - Verify it appears in your Shopify admin + +3. **Check Permissions** + - Ensure you can create, update, and delete products + - Verify inventory management works if needed + +## 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 + +## Troubleshooting + +### Common Issues + +1. **"Invalid API key" error** + + - Verify your access token is correct + - Ensure the token hasn't been revoked + +2. **"Store not found" error** + + - Check your store name spelling + - Ensure you're using the correct subdomain + +3. **"Insufficient permissions" error** + + - Verify your private app has the required scopes + - Reinstall the app if needed + +4. **Rate limiting** + - Shopify has API rate limits (2 requests per second for most endpoints) + - Implement retry logic with exponential backoff + +### Getting Help + +If you encounter issues: + +1. Check Shopify's [API documentation](https://shopify.dev/docs/api) +2. Review your app's permissions in Shopify admin +3. Enable debug logging to see detailed error messages +4. Contact Eden support with specific error details + +## Next Steps + +Once your Shopify integration is configured: + +- Explore Eden's product creation tools +- Set up automated workflows +- Configure inventory management +- Integrate with other Eden features + +For more advanced usage, see our [Shopify API documentation](https://shopify.dev/docs/api) and [Eden tools documentation](/docs/tools/). From a596275bbdfef3ebc863b388211ae21484000028 Mon Sep 17 00:00:00 2001 From: henry <13052648+gitpancake@users.noreply.github.com> Date: Tue, 5 Aug 2025 17:58:49 -0700 Subject: [PATCH 2/5] Add Printify docs --- docs/guides/printify.md | 271 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 271 insertions(+) create mode 100644 docs/guides/printify.md diff --git a/docs/guides/printify.md b/docs/guides/printify.md new file mode 100644 index 0000000..a972ec2 --- /dev/null +++ b/docs/guides/printify.md @@ -0,0 +1,271 @@ +--- +sidebar_position: 1 +--- + +import Figure from '@site/src/components/Figure'; + +# Printify Integration Setup + +:::tip What is Printify Integration? +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. +::: + +## 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 +- A connected sales channel (Shopify, WooCommerce, etc.) for selling products + +## Getting Your Printify Credentials + +### Step 1: Create a Printify Account + +1. **Sign Up for Printify** + + - Go to [printify.com](https://printify.com) + - Click **Sign Up** and create your account + - Verify your email address + +2. **Complete Your Profile** + - Fill in your business information + - Set up your payment method + - Complete any required verification 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 + +1. **Check Connection Status** + + - Return to your Printify dashboard + - Go to **Shops** → **Sales channels** + - Verify Shopify shows as "Connected" + +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 + +1. **Product Sync Settings** + + - Choose which products to sync (all or selected) + - Set up automatic inventory updates + - Configure pricing and variant mapping + +2. **Order Sync Settings** + - Enable automatic order import from Shopify + - Set up fulfillment notifications + - Configure order status updates + +### Important Notes + +- **One-way sync**: Products created in Printify will sync to Shopify +- **Inventory management**: Printify handles inventory for print-on-demand products +- **Fulfillment**: Orders placed on Shopify will be automatically sent to Printify for fulfillment +- **Pricing**: Set your profit margins in Printify, not Shopify + +## Setting Up Product Templates + +### Understanding Printify Products + +Printify products consist of: + +- **Base Product**: The physical item (t-shirt, mug, poster, etc.) +- **Print Provider**: The company that prints and fulfills your products +- **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 +``` + +### 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) + +## Testing Your Integration + +After setting up your credentials: + +1. **Verify API Access** + + - Test a simple API call to ensure your credentials work + - Try fetching your shop's product list + +2. **Create a Test Product** + + - Use Eden's tools to create a simple test product + - Verify it appears in your Printify dashboard + +3. **Check Permissions** + - Ensure you can create, update, and delete products + - Verify design uploads work correctly + +## Troubleshooting + +### Common Issues + +1. **"Invalid API token" error** + + - Verify your API token is correct + - Ensure the token hasn't been revoked or expired + +2. **"Shop not found" error** + + - Check your shop ID spelling + - Ensure the shop exists and is active + +3. **"Insufficient permissions" error** + + - Verify your API token has the required scopes + - Regenerate the token with proper permissions + +4. **"Product creation failed" error** + + - Check that the print provider is available + - Verify product variants are in stock + - Ensure design files meet size and format requirements + +5. **Rate limiting** + - Printify has API rate limits + - Implement retry logic with exponential backoff + +### Getting Help + +If you encounter issues: + +1. Check Printify's [API documentation](https://printify.com/docs) +2. Review your API token permissions in Printify dashboard +3. Enable debug logging to see detailed error messages +4. Contact Eden support with specific error details + +## Next Steps + +Once your Printify integration is configured: + +- Explore Eden's product creation tools +- Set up automated design workflows +- Configure product templates +- Integrate with your sales channels + +For more advanced usage, see our [Printify API documentation](https://printify.com/docs) and [Eden tools documentation](/docs/tools/). From bf60764e3cf6eed8c20eb8383dc197dc562bb355 Mon Sep 17 00:00:00 2001 From: henry <13052648+gitpancake@users.noreply.github.com> Date: Tue, 5 Aug 2025 18:01:23 -0700 Subject: [PATCH 3/5] Add Captions --- docs/guides/captions.md | 245 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 245 insertions(+) create mode 100644 docs/guides/captions.md diff --git a/docs/guides/captions.md b/docs/guides/captions.md new file mode 100644 index 0000000..2d6ed0a --- /dev/null +++ b/docs/guides/captions.md @@ -0,0 +1,245 @@ +--- +sidebar_position: 1 +--- + +import Figure from '@site/src/components/Figure'; + +# Captions.ai Integration Setup + +:::tip What is Captions.ai Integration? +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. +::: + +## Prerequisites + +Before setting up Captions.ai integration, you'll need: + +- A Captions.ai account (free to create) +- Access to Captions.ai dashboard +- High-quality photos or videos for AI clone creation +- Scripts ready for video generation +- Basic understanding of video content creation + +## Getting Your Captions.ai Credentials + +### Step 1: Create a Captions.ai Account + +1. **Sign Up for Captions.ai** + + - Go to [captions.ai](https://captions.ai) + - Click **Sign Up** and create your account + - 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) + +## Testing Your Integration + +After setting up your credentials: + +1. **Verify API Access** + + - Test a simple API call to ensure your credentials work + - Try fetching your AI clones list + +2. **Create a Test Video** + + - Use Eden's tools to create a simple test video + - Verify the video generates correctly + - Check quality and synchronization + +3. **Test Different Scripts** + - Try various script lengths and styles + - Test with different AI clones + - Verify media integration works + +## Troubleshooting + +### Common Issues + +1. **"Invalid API key" error** + + - Verify your API key is correct + - Ensure the key hasn't been revoked or expired + +2. **"Clone not found" error** + + - Check your clone ID spelling + - Ensure the clone exists and is trained + - Verify clone permissions + +3. **"Script processing failed" error** + + - Check script format and length + - Ensure script content meets guidelines + - Verify no special characters causing issues + +4. **"Media upload failed" error** + + - Check file format and size requirements + - Ensure media meets quality standards + - Verify file permissions + +5. **"Video generation failed" error** + + - Check script and media compatibility + - Ensure clone is fully trained + - Verify all required parameters are provided + +6. **Rate limiting** + - Captions.ai has API rate limits + - Implement retry logic with exponential backoff From 7fb6932f9c7686364e637ef4730ced05224773d0 Mon Sep 17 00:00:00 2001 From: henry <13052648+gitpancake@users.noreply.github.com> Date: Tue, 5 Aug 2025 18:02:34 -0700 Subject: [PATCH 4/5] Add intended use section --- docs/guides/captions.md | 87 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) diff --git a/docs/guides/captions.md b/docs/guides/captions.md index 2d6ed0a..5cfdb74 100644 --- a/docs/guides/captions.md +++ b/docs/guides/captions.md @@ -243,3 +243,90 @@ After setting up your credentials: 6. **Rate limiting** - Captions.ai has API rate limits - Implement retry logic with exponential backoff + +### Getting Help + +If you encounter issues: + +1. Check Captions.ai's [API documentation](https://help.captions.ai/api-reference/api) +2. Review your API key permissions in Captions.ai dashboard +3. Enable debug logging to see detailed error messages +4. Contact Eden support with specific error details + +## 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 + +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 + +## Next Steps + +Once your Captions.ai integration is configured: + +- Explore Eden's video creation tools +- Set up automated video workflows +- Create multiple AI clones for different purposes +- Integrate with your content marketing strategy +- Connect with [Printify](/docs/guides/printify) and [Shopify](/docs/guides/shopify) for complete product-to-video pipeline + +For more advanced usage, see our [Captions.ai API documentation](https://help.captions.ai/api-reference/api) and [Eden tools documentation](/docs/tools/). From a67872c7a02f6a1da892be86396c42504d46c957 Mon Sep 17 00:00:00 2001 From: henry <13052648+gitpancake@users.noreply.github.com> Date: Tue, 5 Aug 2025 18:04:23 -0700 Subject: [PATCH 5/5] Bring docs inline with guides style --- docs/guides/captions.md | 78 ----------------------------------------- docs/guides/printify.md | 67 ----------------------------------- docs/guides/shopify.md | 61 -------------------------------- 3 files changed, 206 deletions(-) diff --git a/docs/guides/captions.md b/docs/guides/captions.md index 5cfdb74..06bf2d6 100644 --- a/docs/guides/captions.md +++ b/docs/guides/captions.md @@ -187,72 +187,6 @@ DEFAULT_OUTPUT_DIR=./generated_videos - **`DEFAULT_VIDEO_STYLE`**: Default video style/theme (optional) - **`DEFAULT_OUTPUT_DIR`**: Default directory for generated videos (optional) -## Testing Your Integration - -After setting up your credentials: - -1. **Verify API Access** - - - Test a simple API call to ensure your credentials work - - Try fetching your AI clones list - -2. **Create a Test Video** - - - Use Eden's tools to create a simple test video - - Verify the video generates correctly - - Check quality and synchronization - -3. **Test Different Scripts** - - Try various script lengths and styles - - Test with different AI clones - - Verify media integration works - -## Troubleshooting - -### Common Issues - -1. **"Invalid API key" error** - - - Verify your API key is correct - - Ensure the key hasn't been revoked or expired - -2. **"Clone not found" error** - - - Check your clone ID spelling - - Ensure the clone exists and is trained - - Verify clone permissions - -3. **"Script processing failed" error** - - - Check script format and length - - Ensure script content meets guidelines - - Verify no special characters causing issues - -4. **"Media upload failed" error** - - - Check file format and size requirements - - Ensure media meets quality standards - - Verify file permissions - -5. **"Video generation failed" error** - - - Check script and media compatibility - - Ensure clone is fully trained - - Verify all required parameters are provided - -6. **Rate limiting** - - Captions.ai has API rate limits - - Implement retry logic with exponential backoff - -### Getting Help - -If you encounter issues: - -1. Check Captions.ai's [API documentation](https://help.captions.ai/api-reference/api) -2. Review your API key permissions in Captions.ai dashboard -3. Enable debug logging to see detailed error messages -4. Contact Eden support with specific error details - ## Complete Workflow Integration Eden's Captions.ai integration is designed to work seamlessly with other platforms in a complete content creation and distribution pipeline: @@ -318,15 +252,3 @@ Eden's Captions.ai integration is designed to work seamlessly with other platfor - Track performance across different platforms - A/B test different scripts and media combinations - Refine your AI clone based on performance data - -## Next Steps - -Once your Captions.ai integration is configured: - -- Explore Eden's video creation tools -- Set up automated video workflows -- Create multiple AI clones for different purposes -- Integrate with your content marketing strategy -- Connect with [Printify](/docs/guides/printify) and [Shopify](/docs/guides/shopify) for complete product-to-video pipeline - -For more advanced usage, see our [Captions.ai API documentation](https://help.captions.ai/api-reference/api) and [Eden tools documentation](/docs/tools/). diff --git a/docs/guides/printify.md b/docs/guides/printify.md index a972ec2..da6f4e4 100644 --- a/docs/guides/printify.md +++ b/docs/guides/printify.md @@ -202,70 +202,3 @@ DEBUG=false - **`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) - -## Testing Your Integration - -After setting up your credentials: - -1. **Verify API Access** - - - Test a simple API call to ensure your credentials work - - Try fetching your shop's product list - -2. **Create a Test Product** - - - Use Eden's tools to create a simple test product - - Verify it appears in your Printify dashboard - -3. **Check Permissions** - - Ensure you can create, update, and delete products - - Verify design uploads work correctly - -## Troubleshooting - -### Common Issues - -1. **"Invalid API token" error** - - - Verify your API token is correct - - Ensure the token hasn't been revoked or expired - -2. **"Shop not found" error** - - - Check your shop ID spelling - - Ensure the shop exists and is active - -3. **"Insufficient permissions" error** - - - Verify your API token has the required scopes - - Regenerate the token with proper permissions - -4. **"Product creation failed" error** - - - Check that the print provider is available - - Verify product variants are in stock - - Ensure design files meet size and format requirements - -5. **Rate limiting** - - Printify has API rate limits - - Implement retry logic with exponential backoff - -### Getting Help - -If you encounter issues: - -1. Check Printify's [API documentation](https://printify.com/docs) -2. Review your API token permissions in Printify dashboard -3. Enable debug logging to see detailed error messages -4. Contact Eden support with specific error details - -## Next Steps - -Once your Printify integration is configured: - -- Explore Eden's product creation tools -- Set up automated design workflows -- Configure product templates -- Integrate with your sales channels - -For more advanced usage, see our [Printify API documentation](https://printify.com/docs) and [Eden tools documentation](/docs/tools/). diff --git a/docs/guides/shopify.md b/docs/guides/shopify.md index aefb83c..02c3dce 100644 --- a/docs/guides/shopify.md +++ b/docs/guides/shopify.md @@ -128,24 +128,6 @@ DEBUG=false # Does not need to change - **`SHOPIFY_LOCATION_ID`**: The numeric ID of your primary location for inventory management - **`DEBUG`**: Enable debug logging for troubleshooting (optional) -## Testing Your Integration - -After setting up your credentials: - -1. **Verify API Access** - - - Test a simple API call to ensure your credentials work - - Try fetching your store's product list - -2. **Create a Test Product** - - - Use Eden's tools to create a simple test product - - Verify it appears in your Shopify admin - -3. **Check Permissions** - - Ensure you can create, update, and delete products - - Verify inventory management works if needed - ## Security Best Practices - **Keep your access token secure** - never commit it to version control @@ -153,46 +135,3 @@ After setting up your credentials: - **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 - -## Troubleshooting - -### Common Issues - -1. **"Invalid API key" error** - - - Verify your access token is correct - - Ensure the token hasn't been revoked - -2. **"Store not found" error** - - - Check your store name spelling - - Ensure you're using the correct subdomain - -3. **"Insufficient permissions" error** - - - Verify your private app has the required scopes - - Reinstall the app if needed - -4. **Rate limiting** - - Shopify has API rate limits (2 requests per second for most endpoints) - - Implement retry logic with exponential backoff - -### Getting Help - -If you encounter issues: - -1. Check Shopify's [API documentation](https://shopify.dev/docs/api) -2. Review your app's permissions in Shopify admin -3. Enable debug logging to see detailed error messages -4. Contact Eden support with specific error details - -## Next Steps - -Once your Shopify integration is configured: - -- Explore Eden's product creation tools -- Set up automated workflows -- Configure inventory management -- Integrate with other Eden features - -For more advanced usage, see our [Shopify API documentation](https://shopify.dev/docs/api) and [Eden tools documentation](/docs/tools/).