🚀 API Documentation

<?php
$apiKey = 'sk_live_your_secret_key';
$pdfContent = base64_encode(file_get_contents('document.pdf'));

$ch = curl_init('https://pdf-ninja.io/api/v1/pdf/compress');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'pdf_base64' => $pdfContent,
        'level' => 'medium'
    ])
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

if ($result['success']) {
    file_put_contents('compressed.pdf', base64_decode($result['data']['pdf_base64']));
    echo "Compressed! Saved " . $result['data']['savings_percent'] . "%";
}
?>

const apiKey = 'sk_live_your_secret_key';

// Read file and convert to base64
const fileInput = document.querySelector('input[type="file"]');
const file = fileInput.files[0];
const reader = new FileReader();

reader.onload = async function(e) {
    const base64 = e.target.result.split(',')[1];

    const response = await fetch('https://pdf-ninja.io/api/v1/pdf/compress', {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${apiKey}`,
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            pdf_base64: base64,
            level: 'medium'
        })
    });

    const result = await response.json();

    if (result.success) {
        // Download compressed PDF
        const link = document.createElement('a');
        link.href = `data:application/pdf;base64,${result.data.pdf_base64}`;
        link.download = 'compressed.pdf';
        link.click();

        console.log(`Saved ${result.data.savings_percent}%`);
    }
};

reader.readAsDataURL(file);

import requests
import base64

api_key = 'sk_live_your_secret_key'

# Read PDF and encode to base64
with open('document.pdf', 'rb') as f:
    pdf_base64 = base64.b64encode(f.read()).decode('utf-8')

response = requests.post(
    'https://pdf-ninja.io/api/v1/pdf/compress',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={
        'pdf_base64': pdf_base64,
        'level': 'medium'
    }
)

result = response.json()

if result['success']:
    # Save compressed PDF
    compressed_data = base64.b64decode(result['data']['pdf_base64'])
    with open('compressed.pdf', 'wb') as f:
        f.write(compressed_data)

    print(f"Saved {result['data']['savings_percent']}%")

const fs = require('fs');
const axios = require('axios');

const apiKey = 'sk_live_your_secret_key';

// Read PDF and encode to base64
const pdfBuffer = fs.readFileSync('document.pdf');
const pdfBase64 = pdfBuffer.toString('base64');

async function compressPdf() {
    const response = await axios.post(
        'https://pdf-ninja.io/api/v1/pdf/compress',
        {
            pdf_base64: pdfBase64,
            level: 'medium'
        },
        {
            headers: {
                'Authorization': `Bearer ${apiKey}`,
                'Content-Type': 'application/json'
            }
        }
    );

    if (response.data.success) {
        // Save compressed PDF
        const compressedBuffer = Buffer.from(
            response.data.data.pdf_base64,
            'base64'
        );
        fs.writeFileSync('compressed.pdf', compressedBuffer);

        console.log(`Saved ${response.data.data.savings_percent}%`);
    }
}

compressPdf();

<?php
$apiKey = 'sk_live_your_secret_key';

$files = [
    ['pdf_base64' => base64_encode(file_get_contents('doc1.pdf'))],
    ['pdf_base64' => base64_encode(file_get_contents('doc2.pdf'))],
    ['pdf_url' => 'https://example.com/doc3.pdf']
];

$ch = curl_init('https://pdf-ninja.io/api/v1/pdf/merge');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'files' => $files,
        'page_size' => 'A4'
    ])
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

if ($result['success']) {
    file_put_contents('merged.pdf', base64_decode($result['data']['pdf_base64']));
    echo "Merged {$result['data']['files_count']} files, {$result['data']['total_pages']} pages";
}
?>

import requests
import base64

api_key = 'sk_live_your_secret_key'

files = []
for filename in ['doc1.pdf', 'doc2.pdf', 'doc3.pdf']:
    with open(filename, 'rb') as f:
        files.append({
            'pdf_base64': base64.b64encode(f.read()).decode('utf-8')
        })

response = requests.post(
    'https://pdf-ninja.io/api/v1/pdf/merge',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={
        'files': files,
        'page_size': 'A4'
    }
)

result = response.json()

if result['success']:
    merged_data = base64.b64decode(result['data']['pdf_base64'])
    with open('merged.pdf', 'wb') as f:
        f.write(merged_data)

    print(f"Merged {result['data']['files_count']} files")

import requests
import base64

api_key = 'sk_live_your_secret_key'

with open('document.pdf', 'rb') as f:
    pdf_base64 = base64.b64encode(f.read()).decode('utf-8')

# Split into fixed-size chunks (5 pages each)
response = requests.post(
    'https://pdf-ninja.io/api/v1/pdf/split',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={
        'pdf_base64': pdf_base64,
        'mode': 'fixed',
        'options': {'pages_per_file': 5}
    }
)

result = response.json()

if result['success']:
    for i, file in enumerate(result['data']['files']):
        pdf_data = base64.b64decode(file['pdf_base64'])
        with open(f'split_{i+1}.pdf', 'wb') as f:
            f.write(pdf_data)
        print(f"Created split_{i+1}.pdf with pages {file['pages']}")

import requests
import base64

api_key = 'sk_live_your_secret_key'

# OCR a scanned PDF in Spanish
with open('scanned_document.pdf', 'rb') as f:
    file_base64 = base64.b64encode(f.read()).decode('utf-8')

response = requests.post(
    'https://pdf-ninja.io/api/v1/pdf/ocr',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={
        'file_base64': file_base64,
        'language': 'spa',
        'output_format': 'json'
    }
)

result = response.json()

if result['success']:
    print(f"Extracted {result['data']['word_count']} words")
    print(result['data']['text'])

<?php
$apiKey = 'sk_live_your_secret_key';
$pdfContent = base64_encode(file_get_contents('contract.pdf'));

$data = [
    'title' => 'Service Agreement',
    'message' => 'Please sign this agreement.',
    'signers' => [
        [
            'name' => 'John Doe',
            'email' => '[email protected]'
        ],
        [
            'name' => 'Jane Smith',
            'email' => '[email protected]'
        ]
    ],
    'pdf_base64' => $pdfContent,
    'external_id' => 'contract-2024-001',
    'expires_in_days' => 14
];

$ch = curl_init('https://pdf-ninja.io/api/v1/signature-requests');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data)
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

if ($result['success']) {
    echo "Signature request created: " . $result['data']['id'] . "\n";

    // Get signing URLs for each signer
    foreach ($result['data']['signers'] as $signer) {
        echo $signer['name'] . ": " . $signer['sign_url'] . "\n";
    }
}
?>

import requests
import base64

api_key = 'sk_live_your_secret_key'

# Read PDF and encode to base64
with open('contract.pdf', 'rb') as f:
    pdf_base64 = base64.b64encode(f.read()).decode('utf-8')

data = {
    'title': 'Service Agreement',
    'message': 'Please sign this agreement.',
    'signers': [
        {'name': 'John Doe', 'email': '[email protected]'},
        {'name': 'Jane Smith', 'email': '[email protected]'}
    ],
    'pdf_base64': pdf_base64,
    'external_id': 'contract-2024-001',
    'expires_in_days': 14
}

response = requests.post(
    'https://pdf-ninja.io/api/v1/signature-requests',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json=data
)

result = response.json()

if result.get('success'):
    print(f"Created: {result['data']['id']}")

    # Get signing URLs
    for signer in result['data']['signers']:
        print(f"{signer['name']}: {signer['sign_url']}")

const apiKey = 'sk_live_your_secret_key';

// Convert file to base64
async function fileToBase64(file) {
    return new Promise((resolve) => {
        const reader = new FileReader();
        reader.onload = () => resolve(reader.result.split(',')[1]);
        reader.readAsDataURL(file);
    });
}

async function createSignatureRequest(file) {
    const pdfBase64 = await fileToBase64(file);

    const response = await fetch('https://pdf-ninja.io/api/v1/signature-requests', {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${apiKey}`,
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            title: 'Service Agreement',
            message: 'Please sign this agreement.',
            signers: [
                { name: 'John Doe', email: '[email protected]' },
                { name: 'Jane Smith', email: '[email protected]' }
            ],
            pdf_base64: pdfBase64,
            external_id: 'contract-2024-001',
            expires_in_days: 14
        })
    });

    const result = await response.json();

    if (result.success) {
        console.log('Created:', result.data.id);

        // Signing URLs for embedding or redirecting
        result.data.signers.forEach(signer => {
            console.log(`${signer.name}: ${signer.sign_url}`);
        });
    }

    return result;
}

<?php
$apiKey = 'sk_live_your_secret_key';
$requestId = 'sr_a1b2c3d4e5f6g7h8i9j0k1l2';

$ch = curl_init("https://pdf-ninja.io/api/v1/signature-requests/{$requestId}/download");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey
    ]
]);

$pdfContent = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($httpCode === 200) {
    file_put_contents('signed_contract.pdf', $pdfContent);
    echo "Downloaded signed document!";
}
?>

import hmac
import hashlib
from flask import Flask, request

app = Flask(__name__)
WEBHOOK_SECRET = 'your_webhook_secret'

@app.route('/webhook', methods=['POST'])
def handle_webhook():
    payload = request.data
    signature = request.headers.get('X-PDF-Ninja-Signature', '')

    expected = 'sha256=' + hmac.new(
        WEBHOOK_SECRET.encode(),
        payload,
        hashlib.sha256
    ).hexdigest()

    if hmac.compare_digest(expected, signature):
        data = request.json
        print(f"Received: {data['event']}")
        return 'OK', 200
    else:
        return 'Invalid signature', 401