4 min read
API Overview
Introduction
The I Hate PPT API provides developers with a complete programming interface, allowing you to integrate AI PPT generation functionality into your own applications.
Basic Information
Base URL
https://api.ihateppt.com/v1
Authentication
All API requests require an API key in the request header:
Authorization: Bearer YOUR_API_KEY
Data Format
- Request Format: JSON
- Response Format: JSON
- Character Encoding: UTF-8
Quick Start
1. Get API Key
- Log in to I Hate PPT Console
- Go to "API Management" page
- Create a new API key
- Copy the key and save it securely
2. Send Your First Request
curl -X POST https://api.ihateppt.com/v1/ppt/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"topic": "AI Development Trends",
"mode": "quick",
"language": "en"
}'
3. Handle Response
{
"success": true,
"data": {
"ppt_id": "ppt_123456",
"title": "AI Development Trends",
"pages": 8,
"status": "completed",
"download_url": "https://api.ihateppt.com/v1/ppt/ppt_123456/download"
}
}
Core Features
PPT Generation
- Quick Generation - Generate complete PPT in 30 seconds
- Smart Editing - Edit content through API
- Document Import - Generate PPT from existing documents
- Batch Processing - Generate multiple PPTs in batch
Content Management
- File Upload - Upload documents and images
- Version Control - Manage different versions of PPTs
- Collaborative Editing - Support multi-user collaboration
- Permission Management - Control access permissions
Data Query
- Usage Statistics - Query API usage
- Credit Balance - Check remaining credits
- History Records - Get operation history
- Error Logs - View error information
Error Handling
HTTP Status Codes
200- Request successful400- Invalid request parameters401- Authentication failed403- Insufficient permissions404- Resource not found429- Rate limit exceeded500- Internal server error
Error Response Format
{
"success": false,
"error": {
"code": "INVALID_PARAMETER",
"message": "Parameter topic cannot be empty",
"details": {
"field": "topic",
"value": null
}
}
}
Rate Limits
Free Users
- Request Rate: 10 requests per minute
- Daily Limit: 100 requests
- Concurrent Limit: 2 concurrent requests
Paid Users
- Request Rate: 100 requests per minute
- Daily Limit: 10,000 requests
- Concurrent Limit: 10 concurrent requests
Enterprise Users
- Request Rate: 1,000 requests per minute
- Daily Limit: Unlimited
- Concurrent Limit: 100 concurrent requests
SDK Support
Official SDKs
- Python -
pip install aippt-python - JavaScript -
npm install aippt-js - Java - Maven/Gradle dependency
- PHP - Composer package
Community SDKs
- Go - Community maintained
- Ruby - Community maintained
- C# - Community maintained
- Swift - Community maintained
Best Practices
Request Optimization
- Batch Operations - Use batch APIs whenever possible
- Cache Results - Cache data that doesn't change frequently
- Async Processing - Use async APIs for long-running tasks
- Error Retry - Implement exponential backoff retry mechanism
Security Recommendations
- Protect API Keys - Don't expose API keys in client-side code
- Use HTTPS - Always use HTTPS for API calls
- Validate Input - Validate all input parameters
- Monitor Usage - Monitor API usage and anomalies
Performance Optimization
- Connection Reuse - Reuse HTTP connections
- Compression - Enable gzip compression
- Pagination - Use pagination to avoid large data sets
- Smart Caching - Use caching wisely to reduce requests
Support and Help
Documentation Resources
- API Reference - Complete API reference documentation
- SDK Documentation - SDK usage guides for various languages
- Code Examples - Code examples and tutorials
- Best Practices - Development best practices
Technical Support
- Email Support: api-support@ihateppt.com
- Online Documentation: https://docs.ihateppt.com
- GitHub: https://github.com/ihateppt/api
- Community Forum: https://community.ihateppt.com
Start Using the API - Check out the API Reference Documentation for detailed API interface descriptions.