API Documentation Overview
Comprehensive guide to our microservices API platform. Everything you need to integrate our powerful AI-driven services into your applications.
API Platform Overview
Our microservices-based API platform provides developers with access to cutting-edge AI-powered services for document processing, media conversion, and content generation. Built with scalability, reliability, and ease of integration in mind.
High Performance
Optimized microservices with fast processing times and high throughput.
Enterprise Security
Bank-level security with API key authentication and rate limiting.
Easy Integration
RESTful APIs with comprehensive SDKs and clear documentation.
Scalable
Auto-scaling infrastructure handles any workload size.
Authentication
All API requests require authentication using API keys. Get your keys from the API Hub dashboard.
X-API-Key: your_api_key_here
X-API-Secret: your_api_secret_hereAvailable Microservices
| Service | Description | Rate Limit | Key Features | Endpoints |
|---|---|---|---|---|
|
PDF to Word
|
Convert PDF documents to editable Word format with OCR support | 15 req/min | OCR text extraction, layout preservation, multi-page support | View Details |
|
PDF Merger
|
Combine multiple PDF files into a single document with custom ordering | 20 req/min | Batch merging, page selection, compression options | View Details |
|
Word to PDF
|
Convert Word documents to PDF format with professional formatting | 15 req/min | Document formatting, style preservation, vector graphics support | View Details |
|
Speech to Text
|
Transcribe audio files to text using advanced AI models | 8 req/min | Audio transcription, speaker identification, noise filtering | View Details |
|
Text to Speech
|
Convert text to natural-sounding speech with multiple voices | 8 req/min | Text-to-speech synthesis, multiple voice options, SSML markup support | View Details |
|
Background Remover
|
AI-powered background removal with object preservation | 8 req/min | AI-powered background removal, object edge detection, transparency support | View Details |
|
QR & Barcode
|
Generate QR codes and various barcode formats | 8 req/min | QR/barcode generation, multiple formats, customizable design | View Details |
|
Image Resizer
|
Resize and optimize images with multiple modes and quality settings | 15 req/min | Image resizing, aspect ratio preservation, quality optimization | View Details |
|
Image Format Converter
|
Convert images between 18+ formats including RAW and vector types | 15 req/min | Image format conversion, RAW/vector support, batch processing | View Details |
|
OCR Text Extraction
|
Extract text from PDFs, images, and handwritten documents. Convert PDFs and images to editable Word format with advanced OCR technology. | 8 req/min | Text extraction from images/PDFs, multi-language OCR, layout preservation | View Details |
|
Chemical Equation Balancer
|
Automatically balance chemical equations using advanced stoichiometry algorithms with step-by-step solutions | 20 req/min | Automatic balancing, step-by-step solutions, element validation, complex reactions | View Details |
|
Page Extractor
|
Extract individual pages from PDF files with custom page ordering and multiple output formats | 10 req/min | HTML parsing, content extraction, metadata, link extraction, readability mode | View Details |
|
Smart Dashboard
|
IoT device monitoring and control for existing devices (device management through UI only) | Individual limits | Device monitoring, real-time control, statistics, power detection, read-only access | View Details |
|
Unit Converter
|
Convert between 400+ units across 17 categories including length, weight, temperature, currency, area, volume, speed, time, data storage, bandwidth, pressure, energy, power, torque, frequency, fuel economy, and angle | 30 req/min | Generic and category-specific conversion endpoints, category discovery, health check, structured JSON responses | View Details |
Base URL
All API endpoints use the following base URL:
https://api.yourdomain.com/v1* Replace with your actual API domain
Rate Limiting
Rate limits are enforced per API key to ensure fair usage and system stability.
How It Works
- • Limits reset every minute
- • Per-API-key enforcement
- • HTTP 429 response when exceeded
- • Upgrade options available
Rate Limit Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1640995200
Service-Specific Rate Limits
Each service has its own rate limits to ensure optimal performance and fair usage.
| Service | Rate Limit | Burst Limit | Max File Size |
|---|---|---|---|
| PDF to Word | 15 req/min | 40 req | 10MB |
| PDF Merger | 20 req/min | 50 req | 50MB |
| Word to PDF | 15 req/min | 40 req | 10MB |
| Speech to Text | 8 req/min | 20 req | 25MB |
| Text to Speech | 8 req/min | 20 req | 15KB text |
| Background Remover | 8 req/min | 20 req | 5MB |
| QR & Barcode | 20 req/min | 60 req | N/A |
| Image Resizer | 15 req/min | 40 req | 5MB |
| Image Format Converter | 15 req/min | 35 req | 50MB |
| OCR Text Extraction | 8 req/min | 20 req | 25MB |
| Audio Processor | 12 req/min | 30 req | 25MB |
| Chemical Equation Balancer | 20 req/min | 50 req | 500 chars |
| Smart Dashboard | Device Control: 10 req/min, Heartbeat: 20 req/min, Status: 35 req/min | Device Control: 30 req, Heartbeat: 60 req, Status: 105 req | N/A |
Error Handling
| Status Code | Meaning | Description |
|---|---|---|
| 200 | Success | Request processed successfully |
| 202 | Accepted | Async job accepted for processing |
| 400 | Bad Request | Invalid request parameters or format |
| 401 | Unauthorized | Invalid or missing API credentials |
| 413 | Payload Too Large | File size exceeds limits |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server-side processing error |
Getting Started
1. Get API Keys
Sign up and generate your API keys from the dashboard
2. Choose Service
Select the microservice that fits your needs
3. Integrate
Use our SDKs and documentation to integrate
SDKs & Libraries
Official SDKs and community libraries to accelerate your integration:
Official Python SDK with async support
Node.js and browser-compatible library
Composer package for PHP applications
Direct REST API for any language