Skip to main content
All Catalog API requests require authentication using an API key. This page explains how to obtain and use your API key.

Get your API key

To access the Catalog API, you need an API key. Get your API key from the Catalog Dashboard.
API keys are tied to your account and should be kept secure. Never expose your API key in client-side code or public repositories.

Using your API key

Include your API key in the x-api-key header with every request:
curl -X POST https://api.getcatalog.ai/v2/agentic-search-mini \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"query": "black dress"}'

Authentication errors

If authentication fails, the API returns a 401 Unauthorized response. There are two possible error messages:

Missing API key

If no API key is provided, you’ll receive:
{
  "error": "API key required (x-api-key header or Authorization: Bearer)",
  "status": 401
}

Invalid API key

If an invalid API key is provided, you’ll receive:
{
  "error": "Invalid API key",
  "status": 401
}
Common causes:
  • Missing x-api-key header or Authorization: Bearer header
  • Invalid or expired API key
  • Typo in the API key value
Double-check that your API key is correctly copied and that you’re using either the x-api-key header or the Authorization: Bearer header format.

Next steps