Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openfiles.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Getting Help

GitHub Issues

Report bugs and request features

Email Support

Contact our support team

​
Common Issues

Invalid API Key Error
  • Ensure your key starts with oa_
  • Check for extra spaces or newlines
  • Verify the key in your console
Rate Limiting
  • Free tier: 100 requests/minute
  • Check your usage in the console
  • Consider upgrading for higher limits
AI Not Creating Files
  • Verify your OpenFiles API key is set
  • Check that file operations are enabled
  • Ensure your prompt clearly requests file creation
File Not Found Errors
  • Remember: no leading slashes in paths
  • Use forward slashes even on Windows
  • Check file exists with list operation first
TypeScript/JavaScript
# Clear npm cache
npm cache clean --force

# Reinstall
npm install @openfiles-ai/sdk
Python
# Upgrade pip
pip install --upgrade pip

# Reinstall
pip install --force-reinstall openfiles
OpenAI Integration
  • Ensure you’re importing from @openfiles-ai/sdk/openai
  • Both OpenAI and OpenFiles API keys must be valid
  • Check you’re using a supported OpenAI model
Core Client
  • Verify API key is correctly formatted
  • Check HTTP status codes in error responses
  • Ensure proper async/await usage in Python

​
Debugging Tips

​
Enable Debug Logging

// Set environment variable
process.env.OPENFILES_DEBUG = 'true'

// Or in code
const ai = new OpenAI({
  apiKey: 'sk-...',
  openFilesApiKey: 'oa-...',
  debug: true
})

​
Check API Status

Visit status.openfiles.ai to check service status.

​
Test Your Connection

import { OpenFilesClient } from '@openfiles-ai/sdk/core'

const client = new OpenFilesClient({ 
  apiKey: 'oa-...' 
})

// Test connection
try {
  const files = await client.listFiles()
  console.log('Connection successful!')
} catch (error) {
  console.error('Connection failed:', error)
}

​
FAQ

Currently:
  • ✅ OpenAI (native drop-in)
  • ✅ Any AI via Core Client
Coming soon:
  • 🔜 Anthropic Claude (native)
  • 🔜 Google Gemini (native)
  • 🔜 Cohere (native)
Yes! Use the Core Client for direct file operations without any AI dependencies.
  • Text files - Full support in all SDKs
  • Binary files - Supported in Core Client only (coming to other layers)
  • Free tier: 10MB per file
  • Pro tier: 100MB per file
  • Enterprise: Custom limits
Every write operation creates a new version automatically. You can access any previous version using the version number.

​
Contact Information

​
Enterprise Inquiry

For enterprise usage questions and custom implementations:

Contact Sales

contact@openfiles.aiDiscuss enterprise usage, custom integrations, and volume pricing