API Reference › OpenAPI Spec
OpenAPI Specification
AllPDFMagic follows the OpenAPI 3.1 standard. Import the spec into any compatible tool — Postman, Insomnia, Swagger UI — and get a fully interactive API explorer in seconds.
Spec details
{
"openapi": "3.1.0",
"info": {
"title": "AllPDFMagic API",
"version": "1.0.0",
"description": "PDF processing and AI document intelligence REST API"
},
"servers": [
{ "url": "https://www.allpdfmagic.com", "description": "Production" },
{ "url": "https://www.allpdfmagic.com/api/v1/sandbox", "description": "Sandbox" }
],
"security": [{ "BearerAuth": [] }]
}Endpoints covered
PDF Tools10 endpoints
Compress, merge, split, rotate, add page numbers, protect, watermark, unlock
Conversions9 endpoints
PDF↔Word, PDF↔Excel, PDF↔JPG, PDF→TXT, Image→PDF, HTML→PDF, PDF→CSV
AI / Document Intelligence6 endpoints
OCR, summarise, extract invoice, extract tables, Q&A, generate questions
Workflows8 endpoints
Fraud detection, GSTR-2B reconciliation, contract analysis, auto-redact, compare, cross-check
Bulk Processing2 endpoints
Upload batch job (up to 100 files), poll job status
Usage & Auth3 endpoints
Check usage stats, validate API key, health check
Import into your tool
PostmanRecommended
- 1.
Open Postman → click "Import" - 2.
Select "Link" tab - 3.
Paste: https://www.allpdfmagic.com/openapi.json - 4.
Click "Continue" → "Import"
Insomnia
- 1.
Open Insomnia → Create → Import - 2.
Select "From URL" - 3.
Paste: https://www.allpdfmagic.com/openapi.json - 4.
Click Import
Swagger UI (self-hosted)
- 1.
Deploy Swagger UI (or use swagger.io/tools/swagger-ui) - 2.
Set url: "https://www.allpdfmagic.com/openapi.json" - 3.
Your full API explorer is ready
Authentication
All requests require a Bearer token in the Authorization header. Get your free API key at /dashboard/api.
Authorization: Bearer YOUR_API_KEY