Getting Started

Follow these steps to get an API key and make your first request.

1. Get your API key

Sign in to the Indexly app and go to Settings → API Access. Create an organization-level API key. Keep it secret and do not share it in client-side code or public repositories.

2. Base URL

Use your app URL as the base for all requests, for example:

https://app.indexly.ai

3. Authenticate

Send your API key in the X-API-Key header with every request:

curl --request GET \
  --url 'https://app.indexly.ai/api/v1/validate' \
  --header 'X-API-Key: YOUR_API_KEY'

4. Validate and explore

Call GET /api/v1/validate to confirm your key works. Then use the Visibility and Brands endpoints with a siteId that belongs to your organization (from your Indexly dashboard).

Validate API Key →