API DOCUMENTATION & PLAYGROUND
Integrate 201+ formats, 3,208+ conversion pairs, PDF manipulation, 12-language OCR, SHA-256 verification, and exact byte-cap compression into your stack with a single REST API.
INTERACTIVE CODE BUILDER
Live API Request Playground
→
Quick Start
1
Get your API key
Sign in to your dashboard and generate an API key (or upgrade to the API Plan for 10,000 conversions/month and 2 GB max file size).
2
Upload a file (2-step) or submit directly (1-step)
POST /api/v1/upload
Authorization: Bearer YOUR_API_KEY
Content-Type: multipart/form-data
file: (binary)
# Or 1-step upload + convert:
POST /api/v1/jobs (file + target_format + preset)
3
Start conversion & receive SHA-256 + download token
POST /api/v1/convert
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"upload_id": "019...",
"target_format": "png",
"preset": "web"
}
4
Download output or shred immediately
GET /api/v1/download/{token}
Authorization: Bearer YOUR_API_KEY
# Optional immediate file shredder:
DELETE /api/v1/jobs/{job_id}
Authorization: Bearer YOUR_API_KEY
REST API v1 Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/upload | Upload a source file and receive upload_id + SHA-256 |
| POST | /api/v1/convert | Start conversion from upload_id or file (supports preset, quality, page_range, ocr_language, max_output_bytes) |
| POST | /api/v1/jobs | 1-step multipart file upload + conversion |
| GET | /api/v1/convert/{id}/status | Check conversion status, SHA-256 checksum & download URL |
| GET | /api/v1/jobs/{id} | Alias for job status & output metadata |
| GET | /api/v1/download/{token} | Download converted output file by token |
| GET | /api/v1/jobs/{id}/download/{token} | Download converted output file by job ID + token |
| DELETE | /api/v1/jobs/{id} | Immediately shred source upload & converted output from disk |
| GET | /api/v1/formats | List all 201+ supported formats & MIME types |
| GET | /api/v1/formats/{ext}/targets | List all tested target formats for a source extension |
| GET | /api/v1/account/usage | Check current monthly quota & API key usage |
| GET | /api/v1/account/limits | Check plan rate limit & max file size |
Quotas & Rate Limits
Free / Starter
100 – 500 req/mo • up to 250 MB
Pro / Business
2,000 – 10,000 req/mo • up to 2 GB
API Plan (€29/mo)
10,000 requests/month • 120 req/min • 2 GB
READY TO BUILD?
Generate your API key in seconds and start converting files programmatically.
Get API Access — €29/mo