Skip to main content

​
How do you get started?

​
Step 1: Get your API key

To access the Catalog API, you’ll need an API key. Contact our team to get started.

​
Step 2: Authenticate your requests

Include your API key in the x-api-key header with every request: 
curl -X POST https://api.getcatalog.ai/api/search \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY"
Search for products using natural language queries. The API understands context and intent: 
curl -X POST https://api.getcatalog.ai/api/search \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"query": "black dresses under $100"}'

​
What does a successful response look like?

The API returns structured product data with rich metadata and product attributes: 
{
  "products": [
    {
      "id": "12345",
      "title": "Classic Black Dress",
      "description": "Elegant midi dress perfect for any occasion",
      "vendor": "Fashion Brand",
      "price": 7999,
      "currency": "USD",
      "is_available": true,
      "image_url": "https://example.com/image.jpg",
      "attributes": {
        "color": "black",
        "material": "polyester",
        "category": "Women > Dresses"
      }
    }
  ],
  "meta": {
    "totalItems": 42,
    "totalPages": 5,
    "currentPage": 1,
    "pageSize": 10
  }
}

​
How do you add filters to refine search results?

Combine natural language queries with precise filters to get exactly what you need: 
curl -X POST https://api.getcatalog.ai/api/search \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "query": "long dress",
    "filters": {
      "price_max": 10000,
      "is_available": true,
      "attributes": {
        "color": ["white"]
      }
    }
  }'

​
Explore different search types

Choose the right endpoint for your use case:

​
Learn advanced techniques

Advanced Filtering

Master complex filters, attribute filtering, and search logic

Pagination

Handle large result sets with proper pagination

API Reference

Complete endpoint documentation and response formats

Get Support

Questions? Get help from our team