API Documentation
Integrate powerful file conversion and AI enhancement tools directly into your applications with our easy-to-use API.
Overview
The Pixenith API gives developers programmatic access to our suite of file conversion and AI enhancement tools. With our RESTful API, you can:
- Convert files between various formats
- Enhance images using our AI technology
- Remove or change backgrounds
- Compress files while maintaining quality
- Manage user accounts and subscriptions
- Track usage and conversion history
All API requests are made over HTTPS and return responses in JSON format. Authentication is handled through API keys, which you can generate in your developer dashboard.
API Features
Fast Processing
High-performance API with optimized processing capabilities
Secure Transfers
All API requests are encrypted using HTTPS
Extensive Integrations
Easy integration with popular platforms and frameworks
Detailed Analytics
Track API usage and performance in real-time
Quick Start Guide
Get API Key
Sign up for a developer account and generate your API key from the dashboard.
Install SDK (Optional)
Install our SDK for your preferred programming language to simplify integration.
Make API Requests
Start making API requests using your key for authentication.
Handle Responses
Process the JSON responses from our API in your application.
Authentication Example
curl -X GET "https://api.pixenith.com/v1/user/info" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"File Conversion Example
curl -X POST "https://api.pixenith.com/v1/convert/pdf-to-docx" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: multipart/form-data" \
-F "file=@/path/to/your/document.pdf" \
-F "options={\"quality\":\"high\",\"maintain_formatting\":true}"API Endpoints
| Endpoint | Method | Description |
|---|---|---|
/v1/convert/pdf-to-docx |
POST | Convert PDF files to DOCX format |
/v1/convert/docx-to-pdf |
POST | Convert DOCX files to PDF format |
/v1/convert/image |
POST | Convert between image formats (JPG, PNG, WEBP, etc.) |
/v1/convert/batch |
POST | Convert multiple files in a single request |
/v1/convert/status/{job_id} |
GET | Check the status of a conversion job |
Response Example
{
"job_id": "j_8a7d9f3e2c1b",
"status": "completed",
"created_at": "2023-06-10T15:30:45Z",
"completed_at": "2023-06-10T15:31:20Z",
"output": {
"url": "https://api.pixenith.com/v1/download/8a7d9f3e2c1b",
"expires_at": "2023-06-17T15:31:20Z",
"file_name": "converted_document.docx",
"file_size": 1542321
}
}Client Libraries & SDKs
JavaScript
Easily integrate with web applications using our JavaScript SDK.
npm install pixenith-api-clientPython
Comprehensive Python library for server-side integrations.
pip install pixenith-pythonPHP
PHP SDK for easy integration with your web applications.
composer require pixenith/api-clientAdditional SDKs available for Ruby, Java, .NET, and more.
View All SDKsAPI Pricing
Developer
- 5,000 API calls per month
- 20 requests per minute
- Standard file conversions
- Email support
Business
- 20,000 API calls per month
- 60 requests per minute
- All conversion types
- AI enhancement APIs
- Priority support
Enterprise
- Unlimited API calls
- Custom rate limits
- All features included
- Custom integrations
- Dedicated support manager
- SLA guarantees
API FAQs
We support API key authentication using the Authorization header. Your API key should be passed as a Bearer token in all requests to our API endpoints.
Rate limits vary by plan. Developer plans are limited to 20 requests per minute, Business plans to 60 requests per minute, and Enterprise plans have custom rate limits. If you exceed your rate limit, requests will receive a 429 Too Many Requests response.
Converted files are available for download via their URL for 7 days by default. Business and Enterprise plans can configure longer retention periods if needed.
Yes, you can configure webhook endpoints in your developer dashboard. We'll send notifications when long-running operations like conversions are completed, so you don't need to poll for status updates.
Yes, we provide a sandbox environment for all developers. You can use it to test your integration without affecting your production quotas or generating charges. Sandbox API keys start with "sandbox_".
Ready to get started?
Create a developer account today and start integrating powerful conversion tools into your applications.