Troubleshooting
Template-Specific Issues
Template Not Found
"Template not found" Error
"Template not found" Error
Symptoms: API calls return 404 with “Template not found” messageSolutions:
- Verify Template ID: Check the exact template ID using the templates list endpoint
- Check Category: Ensure you’re looking in the right template category
- Template Status: Verify the template is published and active
- Case Sensitivity: Template IDs are case-sensitive
Data Validation Errors
"Validation failed" Error
"Validation failed" Error
Symptoms: PDF generation fails with data validation errorsSolutions:
- Check Required Fields: Ensure all required fields are provided
- Data Types: Verify data types match template requirements (string, number, date)
- Date Formats: Use YYYY-MM-DD format for dates
- Field Lengths: Check maximum length constraints
Common Issues
Authentication Problems
"Invalid API Key" Error
"Invalid API Key" Error
Symptoms: API calls return 401 Unauthorized with “Invalid API Key” messageSolutions:
- Check Key: Ensure you copied the entire API key without extra spaces
- Header Format: Use exact format:
x-api-key: YOUR_API_KEY - Key Status: Verify key hasn’t been revoked in your dashboard
- Regenerate: Create a new API key if the current one isn’t working
"Unauthorized" Error
"Unauthorized" Error
PDF Generation Issues
"HTML content is required" Error
"HTML content is required" Error
Symptoms: API returns error about missing HTML contentSolutions:
- Request Body: Ensure HTML is provided in the request body
- Content-Type: Check header is set to
application/json - JSON Escape: Verify HTML is properly escaped in JSON
- Empty Content: Make sure HTML field isn’t empty or null
Poor PDF Quality Issues
Poor PDF Quality Issues
Symptoms: Blurry text, missing images, layout problemsSolutions:
- Image Resolution: Use high-resolution images (300+ DPI)
- Font Issues: Use web-safe fonts or embed fonts properly
- CSS Problems: Follow PDF-friendly CSS practices
- Scale Setting: Try different scale values between 0.8-1.2
Subscription & Billing Issues
"Insufficient Balance" Error
"Insufficient Balance" Error
Symptoms: PDF generation blocked due to plan limitsSolutions:
- Check Usage: View current usage in your dashboard
- Plan Upgrade: Consider upgrading to a higher tier
- Billing Issue: Verify payment method is current
- Usage Reset: Wait for next billing cycle if near reset
Payment Failed Issues
Payment Failed Issues
Symptoms: Unable to upgrade plan or payment declinedSolutions:
- Card Details: Check expiration date and CVV code
- Billing Address: Ensure address matches your card exactly
- International Payments: Contact bank about international transactions
- Payment Method: Try different card or PayPal
- Currency Issues: Verify your bank supports USD transactions
Response Times
| Plan | Support Type | Response Time |
|---|---|---|
| Free | Community | Best effort |
| Starter | 24-48 hours | |
| Basic | Priority Email | 12-24 hours |
| Premium | Email + Phone | 2-4 hours |
How to Contact Support
Email Support: support@peedief.com Include in Your Request:- Your account email address
- API key (first 6 characters only)
- Detailed description of the issue
- Steps you’ve already tried
- Error messages (exact text)
- Sample code or HTML (if relevant)
Emergency Contact
For critical issues affecting production systems:- Email: emergency@peedief.com (Premium plans only)
- Response: Within 2 hours during business hours
- Issues: Service outages, data loss, security concerns
Advanced Troubleshooting
Debugging API Calls
Enable detailed logging to diagnose issues:Network Issues
Connection Problems:- Check firewall settings for outbound HTTPS
- Verify DNS resolution for peedief.com
- Test from different network/location
- Use ping/traceroute for network diagnostics
- Increase request timeout (default: 30 seconds)
- Reduce HTML content size
- Optimize images and CSS
- Try during off-peak hours
Performance Troubleshooting
Slow PDF Generation
Common Causes:
- Large images or complex CSS
- External resources (fonts, images)
- Heavy HTML content (>1MB)
- Peak usage times
- Optimize image sizes
- Embed resources as data URLs
- Simplify CSS and layout
- Generate during off-peak hours
Browser Console Errors
For web-based integrations, check browser console: Common Console Errors:- CORS errors: Use server-side API calls instead
- Mixed content: Ensure HTTPS for all resources
- Network errors: Check internet connection
- Authentication: Verify API key configuration
Preventive Measures
Best Practices to Avoid Issues
API Usage
- Implement retry logic with backoff
- Validate HTML before sending
- Use proper error handling
- Monitor usage and limits
Content Optimization
- Test HTML in browser first
- Use web-safe fonts
- Optimize images for web
- Keep HTML under 2MB
Security
- Store API keys securely
- Rotate keys periodically
- Monitor for unusual usage
- Use HTTPS for all requests
Monitoring
- Set up usage alerts
- Monitor error rates
- Track processing times
- Review monthly analytics