# Catalog Documentation

## Docs

- [Migrating from v1 to v2](https://docs.getcatalog.ai/migration-guides/migrating-from-v1-to-v2.md): Complete guide to migrating from Catalog API v1 to v2
- [Migrating from /api to v2](https://docs.getcatalog.ai/migration-guides/migration-from-api-to-v2.md): Complete guide to migrating from Catalog API /api endpoints to v2 endpoints
- [Error Codes](https://docs.getcatalog.ai/resources/error-codes.md): Complete reference for Catalog API error codes and how to handle them
- [Rate Limits](https://docs.getcatalog.ai/resources/rate-limits.md): How Catalog rate limiting works and what to expect in responses
- [Generate Affiliate Links](https://docs.getcatalog.ai/v2/api-reference/endpoints/affiliate/generate-links.md): Convert URLs to affiliate links using the Wildfire network.
- [Cancel Crawl](https://docs.getcatalog.ai/v2/api-reference/endpoints/crawl/cancel-crawl-execution.md): Cancel a running crawl. Stops an active crawl job that is currently processing.
- [Crawl](https://docs.getcatalog.ai/v2/api-reference/endpoints/crawl/crawl.md): Async discovery of collections and product listings for a vendor. Returns immediately with an execution_id to check status.
- [Get Crawl Status](https://docs.getcatalog.ai/v2/api-reference/endpoints/crawl/get-crawl-status.md): Get crawl status and results for an asynchronous crawl job.
- [List Crawls](https://docs.getcatalog.ai/v2/api-reference/endpoints/crawl/list-crawl-executions.md): List all crawls with status. Shows all crawl jobs, their current status, and when they were created.
- [Cancel Extract](https://docs.getcatalog.ai/v2/api-reference/endpoints/extract/cancel-extract-execution.md): Cancel a running extract. Stops an active extract job that is currently processing.
- [Extract](https://docs.getcatalog.ai/v2/api-reference/endpoints/extract/extract.md): Async extraction of product data from URLs or a vendor. Returns immediately with an execution_id to check status and retrieve results.
- [Get Extract Status](https://docs.getcatalog.ai/v2/api-reference/endpoints/extract/get-extract-status.md): Get extract status and results for an asynchronous extract job.
- [List Extracts](https://docs.getcatalog.ai/v2/api-reference/endpoints/extract/list-extract-executions.md): List all extracts with status. Shows all extract jobs, their current status, and when they were created.
- [Get Collections](https://docs.getcatalog.ai/v2/api-reference/endpoints/get-collections.md): Get collections for a vendor with pagination. Ordered by product count.
- [Get Product Listings](https://docs.getcatalog.ai/v2/api-reference/endpoints/get-listings.md): Get product listings from a vendor with pagination. Optionally filter by collection URL.
- [Get Vendors](https://docs.getcatalog.ai/v2/api-reference/endpoints/get-vendors.md): List indexed vendors with pagination. Includes listing counts, collection counts, and latest update timestamps.
- [Agentic Search](https://docs.getcatalog.ai/v2/api-reference/endpoints/search/agentic-search.md): Async AI-powered search with customer profile personalization. Returns immediately with an execution_id to check status and retrieve results.
- [Agentic Search Mini](https://docs.getcatalog.ai/v2/api-reference/endpoints/search/agentic-search-mini.md): Fast synchronous search returning up to 10 products. Optional AI-powered attribute enrichment.
- [Cancel Agentic Search](https://docs.getcatalog.ai/v2/api-reference/endpoints/search/cancel-agentic-search-execution.md): Cancel a running agentic search. Stops an active search job that is currently processing.
- [Get Agentic Search Status](https://docs.getcatalog.ai/v2/api-reference/endpoints/search/get-agentic-search-status.md): Get agentic search status and results for an asynchronous search job.
- [List Agentic Searches](https://docs.getcatalog.ai/v2/api-reference/endpoints/search/list-agentic-search-executions.md): List all agentic searches with status. Shows all search jobs, their current status, and when they were created.
- [Get API Usage Statistics](https://docs.getcatalog.ai/v2/api-reference/endpoints/usage/get-usage.md): Get credit usage and API call statistics by endpoint. Filter by time period (24h, 7d, 30d, 90d, all).
- [Overview](https://docs.getcatalog.ai/v2/api-reference/overview.md): Complete reference for the Catalog API endpoints
- [Authentication](https://docs.getcatalog.ai/v2/authentication.md): Learn how to authenticate your requests to the Catalog API
- [Building AI Shopping Assistants](https://docs.getcatalog.ai/v2/guides/ai-shopping-assistant.md): Learn how to build intelligent shopping assistants using Catalog's AI-powered search
- [Pagination](https://docs.getcatalog.ai/v2/guides/pagination.md): Navigate through large result sets efficiently with pagination
- [Product Comparison](https://docs.getcatalog.ai/v2/guides/product-comparison.md): Learn how to build product comparison features using Catalog's product retrieval capabilities
- [Building a Product Index](https://docs.getcatalog.ai/v2/guides/product-index.md): How to build and maintain your own product index using the Catalog API
- [Quickstart](https://docs.getcatalog.ai/v2/quickstart.md): Make your first Catalog API request in under 5 minutes
- [Overview](https://docs.getcatalog.ai/v2/welcome.md): Modern product discovery and intelligence API for agentic commerce

## OpenAPI Specs

- [openapi](https://docs.getcatalog.ai/api-reference/openapi.json)

## Optional

- [Website](https://www.getcatalog.ai)
- [Support](mailto:founders@getcatalog.ai)