Authentication

Every Data API call is authenticated with a dedicated Data API key. It is separate from your Solver API clientKey, stored encrypted, and draws from the same account balance.

Your Data API key

The Data API has its own key, independent of the Solver API. Provision or view it in the dashboard under the Data API section, where you can also rotate it. The key is stored encrypted at rest, and a positive account balance is required for any billed run.

One balance, two keys
The Data API key and the Solver clientKey are different credentials but share a single wallet. Topping up either product funds both.

Three ways to pass it

You can supply the key in any of three places. The first one found wins, in this order:

  • X-API-Key header preferred. Keeps the credential out of URLs and request bodies.
  • clientKey query parameter convenient for quick tests.
  • clientKey in the JSON body handy when a client makes it hard to set custom headers.
header.sh
curl -s https://api.capzy.ai/v1/amazon/search \
  -H 'X-API-Key: capzy_data_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "params": { "query": "usb c cable" } }'
Keep query-param keys out of logs
A key in the URL can end up in proxy and server logs. Prefer the X-API-Key header for anything beyond a throwaway test.

Get and rotate over the API

The console endpoints let you read and rotate the key programmatically. Reading it the first time auto-provisions a key if you do not have one yet. Rotating invalidates the old value immediately, so update your integrations before you rotate.

manage-key.sh
# Read your current key (auto-provisions one on first read)
curl -s https://api.capzy.ai/v1/data/my/key \
  -H 'X-API-Key: capzy_data_YOUR_KEY'

# Rotate it (the old key stops working immediately)
curl -s -X POST https://api.capzy.ai/v1/data/my/key/rotate \
  -H 'X-API-Key: capzy_data_YOUR_KEY'

Next