Catalog AI
Sign In

API Reference

Complete reference documentation for integrating with the Catalog AI platform.

Base URL

https://catalog-ai.tdcapps.com/api/{organization}

Replace {organization} with your organization ID or slug in organization-scoped endpoint URLs.

For organization discovery, use the global endpoint:

GET /api/organizations/get

Authentication

All API requests require authentication using an API key. You can send the key using either x-api-key or the Authorization header:

x-api-key: YOUR_API_KEY

or

Authorization: Bearer YOUR_API_KEY

See Authentication for detailed information.

Available APIs

🏢 Organizations API

Discover which organizations an API key can access.

📥 AI Import API

Import products from documents with AI-powered extraction.

📦 Products API

Create, read, update, and delete products in your catalog.

✨ Enrichment API

Start enrichment jobs and retrieve AI-generated product data.

🛡️ Validation API

Validate product data accuracy with AI-powered quality checks.

🔭 Market Analysis API

Real-time competitive marketplace intelligence.

🏷️ Brand Enrichment API

Build complete brand profiles at catalog scale.

🗂️ Category Enrichment API

Generate category copy, metadata, and slugs.

📐 Attribute Sets API

Read the attribute sets and attribute IDs a job can target.

🔖 Brands API

Check, create, and read enrichment history for brands.

📁 Categories API

Check, create, and read enrichment history for categories.

📎 File Uploads API

Upload spec sheets and price lists for jobs to read.

🔔 Webhooks

Take job events instead of polling, and manage endpoints.

Response Format

All API responses follow a consistent JSON structure.

Success Response

{
  "success": true,
  "data": {
    // Response data
  }
}

Error Response

{
  "success": false,
  "message": "Error description"
}

HTTP Status Codes

Status Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Missing or invalid API key
403 Forbidden - Insufficient permissions
404 Not Found - Resource does not exist
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Pagination

List endpoints support pagination with the following parameters:

Parameter Type Default Description
page number 1 Page number (starts at 1)
limit number 10 Items per page (max: 100)

Paginated responses include:

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5
    }
  }
}

Rate Limiting

API requests are subject to rate limits. When exceeded, you'll receive a 429 Too Many Requests response.

Rate limit information is included in response headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 47
X-RateLimit-Reset: 1640995200

Next Steps