Catalog AI
Sign In

Quick Start

Get up and running with the Catalog AI Product Enrichment Platform in minutes.

Welcome

This guide will help you onboard to the platform, set up your organization, and run your first product enrichment job.

Step 1: Create Your Account

Sign Up Options

You can create an account using third-party authentication providers:

  • GitHub OAuth: Sign in with your GitHub account
  • Google OAuth: Sign in with your Google account
  1. Visit the sign-up page
  2. Choose your preferred authentication provider (GitHub or Google)
  3. Complete the OAuth authorization process
  4. Your account will be created automatically

Your Profile

After signing up, you'll be able to:

  • Set your display name and profile picture
  • Add passkeys for passwordless login (for returning users)
  • Manage your account preferences

Signing In

  • New users: Use GitHub or Google OAuth to create your account
  • Existing users: Use passkeys (WebAuthn/FIDO2) for secure, passwordless authentication or continue with OAuth providers

Step 2: Create an Organization

Organizations are the central workspace for your product data and team collaboration.

  1. After first login, you'll be prompted to create an organization
  2. Choose a unique organization name and slug (used in URLs)
  3. Optionally upload an organization logo

Organization Features

  • Team Collaboration: Invite members with different roles
  • Shared Resources: API keys, credits, and products are organization-scoped
  • Settings Management: Configure enrichment attributes and webhooks

Step 3: Understanding Credits

The platform uses a credit-based pricing model for product enrichment:

  • Initial Credits: New organizations may start with free trial credits
  • Credit Balance: View your current balance in the Credits section
  • Purchase Credits: Buy additional credits via Stripe integration
  • Credit Usage: Each enrichment job consumes credits based on:
    • Model type (budget-v1, pro-v1)
    • Number of products enriched
    • Enrichment attributes selected

Step 4: Add Your Products

Before enriching, you need to add products to your catalog:

  1. Navigate to Products in the sidebar
  2. Click Add Product or import products in bulk
  3. Fill in required fields:
    • Name: Product name
    • SKU: Unique product identifier
    • URL: Product page URL (used for enrichment)
    • Manufacturer, Brand, MPN: Product identifiers
    • Category: Product category (optional, can be auto-generated during enrichment)
    • Parent Product ID: Link product variants to a parent product (optional)
    • Mark as Parent Product: Check if this product has variants (optional)

Product Data

Products support:

  • Basic information (name, SKU, brand, manufacturer)
  • Product URLs for enrichment
  • Product categories for better organization and category-specific enrichment
  • Parent-child relationships for managing product variants
  • Custom enrichment attributes

Parent-Child Product Relationships

Organize your product variants using parent-child relationships:

  • Parent Products: Main products that have multiple variants (e.g., a t-shirt available in different colors/sizes)
  • Child Products: Specific variants linked to a parent (e.g., Red T-Shirt Size M, Blue T-Shirt Size L)
  • Benefits:
    • Organize product families logically
    • Enrich parent products by aggregating data from all variants
    • Validate parent attributes against child product data
    • Filter and search by product type

Example: A "Classic T-Shirt" parent product with child variants for each color-size combination

Step 5: Configure Enrichment Attributes

Enrichment attributes define what data you want to extract from product pages.

  1. Go to Settings → Enrichment Settings
  2. View existing attributes or create new ones:
    • Name: Attribute identifier
    • Type: text, number, boolean, array
    • Prompt: AI prompt describing what to extract (default)
    • Category-Specific Prompts: Optional prompts for specific product categories
    • Options: For structured data extraction

Default Attributes

The platform comes with common attributes like:

  • Product description
  • Technical specifications
  • Meta Description

Category-Specific Enrichment

You can configure different extraction prompts for different product categories. For example, a "Key Features" attribute might extract:

  • Technical specs for electronics
  • Fabric and care details for apparel
  • Dimensions and assembly info for furniture

This ensures more accurate and relevant data extraction based on product type.

Step 6: Run Your First Enrichment Job

Now you're ready to enrich your products!

  1. Go to Products
  2. Select products to enrich (checkboxes)
  3. Click Enrich Selected Products
  4. Choose a model type:
    • Budget: Fast, cost-effective
    • Normal: Balanced performance (recommended)
    • Pro: Enhanced accuracy
    • Ultra: Highest quality
  5. Click Confirm & Enrich

Job Processing

  • Jobs run automatically in the background
  • View job progress in Products → Enrichment Jobs
  • Each job shows:
    • Status (pending, processing, completed, failed)
    • Progress (processed/total products)
    • Success and failure counts
    • Credit usage
    • Completion time

Job Statuses

  • Pending: Job queued, waiting to start
  • Processing: Actively enriching products
  • Completed: All products processed successfully
  • Completed with Errors: Some products failed
  • Failed: Job failed to complete

Step 7: View Enrichment Results

After job completion:

  1. Click on a product in your product list
  2. View the enrichment history showing:
    • Enriched attributes and their values
    • Timestamp of enrichment
    • Model used

Step 8: Validate Your Products (Optional)

Ensure data quality with product validation:

  1. Select products you want to validate
  2. Click Validate Selected Products
  3. Choose a model type (Budget, Normal, Pro, or Ultra)
  4. Review validation results showing:
    • Overall quality score
    • Attribute-level validity checks
    • Confidence scores
    • Detailed explanations

Learn more in the Product Validation guide.

Step 9: Set Up API Access (Optional)

For programmatic access:

  1. Go to API Keys

  2. Click Create API Key

  3. Configure:

    • Name: Descriptive key name
    • Expiration: Set expiry date (optional)

  4. Save the generated API key securely (shown only once!)

API Key Features

  • Rate limiting with configurable time windows
  • Auto-refilling request quotas
  • Permission-based access control
  • Track usage and request counts

Step 10: Configure Webhooks (Optional)

Stay notified about enrichment and validation events:

  1. Go to Settings → Webhooks
  2. Click Create Webhook
  3. Configure:
    • URL: Your endpoint
    • Events: Select event types
      • product_enrichment.start
      • product_enrichment.completed
      • product_validation.start
      • product_validation.completed
    • Method: POST

Webhook Limit: Maximum 10 webhooks per organization

Next Steps

Now that you're set up, explore more features:

Need Help?

  • Check the documentation sections for detailed guides
  • Review API examples for integration patterns
  • Use the feedback button to report issues or suggest features