Skip to main content

​
API Key Authentication

Most file operations use API key authentication via the x-api-key header.

​
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"

​
Security Best Practices

Never expose your API keys in client-side code or public repositories.
✅ Good Practices:
  • Store API keys in environment variables
  • Use different keys for development and production
  • Regenerate keys if compromised
  • Implement rate limiting in your applications
❌ Avoid:
  • Hardcoding keys in source code
  • Sharing keys in public channels
  • Using production keys in development

​
Rate Limits

TierRequests/MinuteFile Size Limit
Free10010MB
Pro1,000100MB
EnterpriseCustomCustom
Rate limit headers are included in every response:
  • 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
⌘I