Authentication

​

API Key Authentication

​

Getting Your API Key

1. Sign up at console.openfiles.ai
2. Navigate to API Keys in your console
3. Create API Key - Copy your key (starts with oa_)

​

Using Your API Key

curl -X GET "https://api.openfiles.ai/functions/v1/api/files" \
  -H "x-api-key: oa_your_api_key_here"

const response = await fetch('https://api.openfiles.ai/functions/v1/api/files', {
  headers: {
    'x-api-key': 'oa_your_api_key_here'
  }
})

import requests

headers = {
    'x-api-key': 'oa_your_api_key_here'
}

response = requests.get('https://api.openfiles.ai/functions/v1/api/files', headers=headers)

​

Security Best Practices

• Store API keys in environment variables
• Use different keys for development and production
• Regenerate keys if compromised
• Implement rate limiting in your applications

• Hardcoding keys in source code
• Sharing keys in public channels
• Using production keys in development

​

Rate Limits

• X-RateLimit-Limit - Your rate limit ceiling
• X-RateLimit-Remaining - Requests remaining in current window
• X-RateLimit-Reset - UTC time when the rate limit resets