Frequently Asked Questions
General Questions
What is ProxyXAI?
ProxyXAI is an AI API proxy service that provides unified access to multiple AI providers (OpenAI, Anthropic, etc.) with enhanced features like load balancing, rate limiting, usage tracking, and subaccount management.How is ProxyXAI different from using OpenAI directly?
ProxyXAI offers several advantages: - Automatic failover and load balancing across multiple API keys - Detailed usage tracking and billing management - Subaccount system for team collaboration - Enhanced rate limiting and access controls - Support for multiple AI providers through one API - Real-time WebSocket connections - Document parsing capabilitiesWhich AI providers are supported?
We support: - OpenAI (GPT-4, GPT-3.5, DALL-E, Whisper) - Anthropic (Claude 3 family) - Google (Gemini models) - xAI (Grok models) - Perplexity - Cohere - DeepSeek - And many more...Account & Billing
How do I create an account?
1. Visit [m.proxyxai.com](https://m.proxyxai.com) 2. Sign up with your email 3. Your account will be created with an initial API key 4. Add credits to start using the serviceHow does billing work?
- Pay-as-you-go model aligned with official provider rates - Credits are deducted based on actual usage - No monthly fees or subscriptions - Detailed usage reports available via API - Support for subaccount billingWhat is the minimum balance required?
- Regular usage: $1 minimum to make API calls - Creating subaccounts: $20 minimum in parent account - Subaccount initial funding: $2 minimum - API management features: $20 minimumCan I get a refund?
Yes, unused credits can be refunded by: 1. Deleting a subaccount (auto-refund to parent) 2. Using negative CreditGranted in update API 3. Contacting support for main account refundsNote: A small transaction fee (0.2) applies to prevent abuse.
API Usage
Why do some API calls report a 404 error?
Your domain might be configured incorrectly. Please check: - Correct base URL: `https://api.proxyxai.com` - Some libraries need `/v1` suffix: `https://api.proxyxai.com/v1` - Verify the endpoint path is correctError 401: Incorrect API key provided
This happens when: - Wrong API key is used - API base URL is not set to ProxyXAI - Account is suspended due to zero balance - IP is not in whitelist (if configured)Solution: Update your configuration:
client = OpenAI(
api_key="sk-Xvs...", # Your ProxyXAI key
base_url="https://api.proxyxai.com/v1"
)
What if an open source project doesn't support custom API base?
You can: 1. Fork the project and modify the API endpoint 2. Use environment variables if supported 3. Modify the source code to replace `api.openai.com` with `api.proxyxai.com` 4. Contact us for proxy solutionsHow do rate limits work?
Rate limits can be set at multiple levels: - Account level: RPM/RPH/RPD (requests) and TPM/TPH/TPD (tokens) - Model level: Specific limits per model - Inherited from parent account (cannot exceed parent limits) - Default: Very high limits (essentially unlimited)Subaccount Management
Why does calling the subaccount API return 401?
To use subaccount management APIs: - Your account balance must be > $20 - You must have valid permissions - The API key must be activeWhat are the requirements for creating subaccounts?
1. Parent account balance > $20 2. Initial funding ≥ $2 for new subaccount 3. Valid unique name and email 4. Subaccount limits cannot exceed parent limitsCan subaccounts create their own subaccounts?
Yes, if the subaccount: - Has balance > $20 - Has ChildLimit > 0 - Meets other creation requirementsThis creates a hierarchy: Parent → Child → Grandchild
How do I manage subaccount permissions?
Use the update API to set: - `AllowModels`: Whitelist specific models - `AllowIPs`: Restrict to specific IPs/CIDRs - `Resources`: Limit API endpoints - `ModelLimits`: Set per-model rate limitsTechnical Issues
Why does the response return "Insufficient balance"?
The system requires a minimum balance of $1 to prevent asset loss. This happens when: - Account balance < $1 - All credits have expired - Account is suspendedWebSocket connection keeps dropping
Common causes: - Network instability - Idle timeout (implement heartbeat) - Rate limits exceeded - Invalid authenticationSolution: Implement reconnection logic with exponential backoff
Document parsing fails with "file too large"
Limits for document parsing: - PDF files: Maximum 4.5MB - Maximum 5 files per request - Supported formats: PDF, TXT, DOCX, XLSX, CSV, MD, HTMLSplit large documents or compress PDFs before uploading.
Security & Privacy
How are API keys stored?
- All keys are encrypted using AES-256 - Zero-trust design: even database admins cannot access plaintext keys - Keys are never logged or exposed in responses - Automatic encryption/decryption in memory onlyCan I restrict access by IP?
Yes, use the AllowIPs field: ```bash curl -X PUT https://api.proxyxai.com/x-users/42 \ -H "Authorization: Bearer $KEY" \ -d '{"AllowIPs": "192.168.1.0/24 10.0.0.5"}' ```Is my data logged or stored?
- Request/response bodies are not permanently stored - Only usage metrics are tracked (tokens, costs) - Optional chat history for user convenience - All data transmission is encrypted - We comply with data protection regulationsAdvanced Features
What is Level-based routing?
Levels allow organizing API keys by tier: - Level 0-10: Different key pools - Automatic failover between levels - Model-specific level mapping - Load distribution across providersExample: Route GPT-4 to Level 2 keys, GPT-3.5 to Level 1
How does the commission system work?
When doing cross-generation funding: - Direct parent-child: No commission - Cross-generation: 5% commission to child's parent - Helps incentivize account distribution - Automatic calculation and distributionWhat are Model Mappers?
Model Mappers allow request transformation: ``` gpt-3.5-turbo → gpt-4 (upgrade model) claude-2 → claude-3 (version migration) ``` Set via configuration API or user settings.How do I monitor system status?
- Status page: [status.proxyxai.com](https://status.proxyxai.com) - Health check: `GET /healthz` - Usage logs: Dashboard API - Email notifications for limits - Real-time WebSocket eventsTroubleshooting
My request succeeded but no usage was recorded
This can happen when: - Using an unrecognized model name - Request failed after proxy but before completion - Usage recording is delayed (wait 1-2 minutes)Check your usage logs for details.
Getting random 429 errors despite low usage
Possible causes: - Model-specific limits reached - Upstream provider rate limits - Token limits (TPM/TPH) exceeded - Parent account limits affecting subaccountCheck: /dashboard/x-user-info for current limits
News/notifications not appearing
News items have expiration dates: - System news: 7 days default - User news: 32 days default - Check if news has expired - Verify correct API endpoint - Maximum 8 news items shownConfiguration changes not taking effect
- Configuration updates are immediate - Some changes trigger key reload (3-minute delay) - Verify syntax for mappers and lists - Check response for error messages - Confirm you have proper permissionsSupport
How do I get help?
Multiple support channels: 1. Email: [email protected] 2. Telegram: [@proxyxai](https://t.me/proxyxai) 3. WeChat: See QR code in docs 4. Twitter/X: [@proxyxai](https://x.com/proxyxai) 5. Documentation: [docs.proxyxai.com](https://proxyxai.com/docs)Is there an SLA?
- 99.9% uptime target - Automatic failover systems - Multiple datacenter deployment - 24/7 monitoring - Status page for transparencyEnterprise SLAs available on request.