Overview

The Catalog API enables AI-powered product search across the web, discovery and indexing of product listings, real-time extraction of rich product data, and affiliate link generation for monetization. All endpoints return JSON responses.

Base URL

https://api.getcatalog.ai

Authentication

All requests require an API key in the x-api-key header. See Authentication for details.

Endpoints

Extract

Endpoint	Method	Description
`/v1/products`	POST	Async extraction of product data from product URLs (up to 1000)
`/v1/products`	GET	List all extracts with status
`/v1/products/{execution_id}`	GET	Get extract status and results
`/v1/products/{execution_id}`	DELETE	Cancel a running extract

Search

Endpoint	Method	Description
`/v1/agentic-search`	POST	AI-powered natural language search with customer profile personalization
`/v1/agentic-search-mini`	POST	Fast synchronous search returning up to 10 products

Crawl

Endpoint	Method	Description
`/v1/crawl`	POST	Async discovery of collections and product listings for a vendor
`/v1/crawl`	GET	List all crawls with status
`/v1/crawl/{execution_id}`	GET	Get crawl status and results
`/v1/crawl/{execution_id}`	DELETE	Cancel a running crawl

Vendors

Endpoint	Method	Description
`/v1/vendors`	GET	List your crawled vendors

Collections

Endpoint	Method	Description
`/v1/collections`	POST	Get collections for a vendor

Listings

Endpoint	Method	Description
`/v1/listings`	POST	Get product listings

Affiliate

Endpoint	Method	Description
`/v1/affiliate`	POST	Convert URLs to affiliate links

Usage

Endpoint	Method	Description
`/v1/usage`	GET	Get credit usage and API call statistics

Response format

Response structures vary by endpoint: Listings endpoints (vendors, collections, listings) return:

{
  "data": [{ "_truncated": "Additional items omitted for display" }],
  "pagination": {
    "page": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10,
    "has_next": true,
    "has_prev": false
  },
  "meta": {}
}

Search endpoints (agentic-search, agentic-search-mini) return:

{
  "products": [{ "_truncated": "Additional items omitted for display" }],
  "meta": {
    "totalItems": 100,
    "urls": ["_truncated"]
  }
}

/{execution_id} endpoints also include execution_id and status fields:

{
  "status": "completed",
  "results": {
    "products": [{ "_truncated": "Additional items omitted for display" }],
    "meta": {
      "total_requested": 100,
      "total_successful": 98,
      "total_failed": 2
    }
  },
  "pagination": {
    "page": 1,
    "limit": 50,
    "total_items": 100,
    "total_pages": 2,
    "has_next": true
  }
}

Error handling

Errors return appropriate HTTP status codes with structured error details: Standard error responses (400, 401, 402, 403, 404, 409, 429, 500):

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description",
    "request_id": "req_truncated"
  }
}

All error responses include a Request-ID header that matches the request_id in the response body. See Error Codes for the complete reference.

Get Started

API Reference

Guides

Resources

Base URL

Authentication

Endpoints

Extract

Search

Crawl

Vendors

Collections

Listings

Affiliate

Usage

Response format

Error handling

​Base URL

​Authentication

​Endpoints

​Extract

​Search

​Crawl

​Vendors

​Collections

​Listings

​Affiliate

​Usage

​Response format

​Error handling

Base URL

Authentication

Endpoints

Extract

Search

Crawl

Vendors

Collections

Listings

Affiliate

Usage

Response format

Error handling