Catalog AI
Sign In

Platform Overview

Welcome to the Catalog AI Product Enrichment Platform documentation. This platform helps you automatically enrich product data using AI.

What is Product Enrichment?

Product enrichment is the process of automatically extracting and adding detailed information to your product catalog from various sources, primarily product web pages. Our platform uses advanced AI models to:

  • Extract structured data from unstructured product pages
  • Classify products using Google Product Taxonomy
  • Generate descriptions and detailed specifications
  • Standardize product information across your catalog
  • Track changes over time with enrichment history

What is Product Validation?

Product validation is the process of verifying the accuracy and quality of your existing product data. The platform uses AI to:

  • Verify accuracy of product attributes
  • Identify errors and inconsistencies
  • Provide confidence scores for each attribute
  • Explain findings with detailed reasoning
  • Track quality over time with validation history

Key Concepts

Organizations

Organizations are the top-level workspace where all your data lives:

  • Each user can be a member of multiple organizations
  • Resources (products, API keys, credits) are scoped to organizations
  • Team members can be invited with different roles (admin, member)
  • Each organization has its own credit balance and settings

Products

Products are the core entities you'll be working with:

  • Each product has basic attributes (name, SKU, URL, brand, manufacturer)
  • Products can be categorized using Google Product Taxonomy (6000+ categories)
  • Products can be enriched multiple times with enrichment history tracked
  • Products belong to an organization

Enrichment Jobs

Enrichment jobs process multiple products automatically in the background:

  • Job Status: pending → processing → completed/failed
  • Model Selection: Choose from Budget, Normal, Pro, or Ultra
  • Background Processing: Jobs run automatically
  • Progress Tracking: Real-time job status and per-product results
  • Webhook Notifications: Get notified when jobs start and complete

Validation Jobs

Validation jobs verify product data quality in the background:

  • Job Status: pending → processing → completed/failed
  • Model Selection: Choose from Budget, Normal, Pro, or Ultra
  • Background Processing: Jobs run automatically
  • Quality Scores: Overall and per-attribute validation scores
  • Webhook Notifications: Get notified when jobs start and complete

Enrichment Attributes

Attributes define what data to extract from products:

  • Type: text, number, boolean, or array
  • Prompt: Describes what the AI should extract (default)
  • Category-Specific Prompts: Optional prompts for specific product categories
  • Custom Attributes: Create organization-specific attributes
  • Active/Inactive: Enable or disable attributes per organization
  • Ordered: Control the sequence of attributes

Credits

Credits are the currency for using the enrichment and validation services:

  • Credit Balance: Organization-level balance
  • Purchase: Buy credits via Stripe integration
  • Usage: Consumed during enrichment and validation based on model and attributes
  • Transactions: Track purchases, usage, refunds, and adjustments

API Keys

API keys enable programmatic access to the platform:

  • Organization-scoped: Each key belongs to a user in an organization
  • Rate Limiting: Optional request limits with auto-refill
  • Expiration: Optional expiry dates
  • Usage Tracking: Monitor request counts and patterns

How It Works

Enrichment Workflow

  1. Product Import: Add products via UI or API
  2. Enrichment Request: Select products and start enrichment job
  3. Background Processing: Job processes your products automatically
  4. Monitor Progress: Track job status in real-time
  5. Get Notified: Receive webhook notifications on completion
  6. View Results: Access enriched data in your product enrichment history

Validation Workflow

  1. Product Selection: Choose products with existing data
  2. Validation Request: Select products and start validation job
  3. Background Processing: Job validates your products automatically
  4. Monitor Progress: Track job status in real-time
  5. Get Notified: Receive webhook notifications on completion
  6. Review Results: Access validation scores, confidence levels, and explanations

User Roles

Organization Admin

  • Create and manage organization settings
  • Invite and remove team members
  • Manage webhooks
  • Configure enrichment attributes
  • Full access to all features

Organization Member

  • View products and enrichment jobs
  • Create enrichment jobs
  • Generate API keys
  • View credits (cannot purchase)

Authentication Methods

OAuth Providers (Sign Up)

New users must sign up using one of the following third-party providers:

GitHub OAuth

  • Single sign-on with GitHub accounts
  • Automatic email verification
  • Quick and easy account creation

Google OAuth

  • Single sign-on with Google accounts
  • Automatic email verification
  • Quick and easy account creation

Passkeys (Existing Users)

Once you have an account, you can use passkeys for secure, passwordless authentication:

  • Device-based authentication: Use biometrics or security keys
  • Enhanced security: FIDO2/WebAuthn standard
  • No passwords: Eliminates password-related security risks
  • Convenient: Quick authentication with Face ID, Touch ID, or security keys

Note: Passkeys are available only after creating an account via OAuth providers. New users must first sign up with GitHub or Google.

Security Features

  • Secure Sessions: Automatic session management with expiration
  • Encrypted Storage: API keys stored securely
  • Rate Limiting: Configurable per API key
  • Data Isolation: Complete separation between organizations
  • HTTPS Only: All communications encrypted
  • Access Control: Role-based permissions

Integration Options

REST API

  • Full programmatic access to all features
  • API key-based authentication
  • Rate limiting and usage tracking

Webhooks

  • Real-time event notifications
  • Configurable event types
  • Up to 10 webhooks per organization

Payment Processing

  • Secure credit purchase
  • Multiple payment methods supported
  • Instant credit delivery

Platform Limits

  • API Keys: Unlimited per organization
  • Webhooks: Maximum 10 per organization
  • Products: Unlimited
  • Enrichment Jobs: Unlimited (credit-based)
  • Team Members: Unlimited
  • Organizations: Unlimited per user

Next Steps

Ready to get started?

  1. Quick Start Guide - Get up and running
  2. Product Enrichment - Learn enrichment workflows
  3. Product Validation - Learn validation workflows
  4. API Reference - Integrate with your systems
  5. Credits & Billing - Understand pricing

Support

Need help?

  • Review the documentation thoroughly
  • Use the in-app feedback button
  • Check for updates in the changelog