Authentication

The Reminix API uses API keys for authentication. This guide shows you how to get and use your API keys.

Getting Your API Key

  1. Log in to your Reminix Dashboard
  2. Navigate to SettingsAPI Keys
  3. Click Generate New Key
  4. Copy your API key and store it securely

⚠️ Warning
Your API key is sensitive information. Never commit it to version control or share it publicly.

Using Your API Key

Include your API key in the Authorization header:

Authentication Header:

$ Authorization: Bearer YOUR_API_KEY
shell

Example with cURL

cURL Example:

$ curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.reminix.com/v1/agents
shell

Example with JavaScript

JavaScript Example:

const response = await fetch('https://api.reminix.com/v1/agents', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
javascript

Rate Limits

API requests are rate limited to prevent abuse:

  • Free tier: 100 requests per hour
  • Pro tier: 1,000 requests per hour
  • Enterprise: Custom limits

Rate limit headers are included in all responses:

Rate Limit Headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200