getting-started
Authentication

Authentication

Interstitial uses API keys for authentication. Include your API key in the x-api-key header with every request.

Getting an API Key

For development, use the default dev key: dev-key-12345

In production, API keys will be managed through your account dashboard.

Using Your API Key

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

curl -H "x-api-key: dev-key-12345" \
  http://localhost:3001/api/v1/services

API Key Security

  • Never commit API keys to version control
  • Use environment variables in production
  • Rotate keys if compromised
  • Use different keys for different environments

Rate Limits

Rate limits are applied per API key. Current limits:

  • Development: 1000 requests/hour
  • Production: Varies by plan

Rate limit headers are included in responses:

x-ratelimit-limit: 1000
x-ratelimit-remaining: 999
x-ratelimit-reset: 1640995200
IntroductionQuickstart