API Authentication

Types of Keys

AI Search Index uses two types of keys for different purposes:

Getting Your API Key

1. 1

   Log in to your AI Search Index dashboard

2. 2

   Go to Account → API Keys

3. 3

   Click Create API Key

4. 4

   Copy your new API key (it will only be shown once)

Using Your API Key

Include your API key in the x-api-key header:

curl -X GET https://aisearchindex.com/api/v1/websites \
  -H "x-api-key: api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const response = await fetch('https://aisearchindex.com/api/v1/websites', {
  headers: {
    'x-api-key': 'api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://aisearchindex.com/api/v1/websites',
    headers={'x-api-key': 'api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}
)
data = response.json()

Security Best Practices

• ✓Store API keys in environment variables
• ✓Use server-side code to make API requests
• ✓Rotate keys periodically
• ✓Use different keys for different environments
• ✗Never include API keys in client-side JavaScript
• ✗Never commit API keys to version control