API Integration Guide

1. Get your API token from the Admin Panel → Open API tab

2. Send a POST request with your PDF file:

curl -X POST https://your-domain.com/api/v1/clean \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@document.pdf"

3. Poll the task status until completed:

curl https://your-domain.com/api/v1/task/{task_id} \
  -H "Authorization: Bearer YOUR_API_TOKEN"

4. Download the cleaned PDF:

curl -o cleaned.pdf https://your-domain.com/api/v1/task/{task_id}/download \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Python

import requests, time

API_URL = "https://your-domain.com"
TOKEN = "pk_live_your_token_here"
HEADERS = {"Authorization": f"Bearer {TOKEN}"}

# Upload and clean a PDF file
with open("document.pdf", "rb") as f:
    resp = requests.post(f"{API_URL}/api/v1/clean", headers=HEADERS, files={"file": f})
task = resp.json()
print(f"Task created: {task['task_id']}")

# Poll until complete
while task["status"] not in ("completed", "failed"):
    time.sleep(2)
    task = requests.get(f"{API_URL}/api/v1/task/{task['task_id']}", headers=HEADERS).json()
    print(f"  Status: {task['status']} Progress: {task['progress']}%")

# Download result
if task["status"] == "completed":
    pdf = requests.get(task["download_url"], headers=HEADERS)
    with open("cleaned.pdf", "wb") as f:
        f.write(pdf.content)
    print("Cleaned PDF saved!")

# --- Or clean from URL ---
resp = requests.post(f"{API_URL}/api/v1/clean-url", headers=HEADERS,
                     data={"url": "https://example.com/document.pdf"})

JavaScript (Node.js)

const fs = require('fs');
const FormData = require('form-data');
const axios = require('axios');

const API_URL = 'https://your-domain.com';
const TOKEN = 'pk_live_your_token_here';
const headers = { 'Authorization': `Bearer ${TOKEN}` };

async function cleanPDF(filePath) {
  // Upload
  const form = new FormData();
  form.append('file', fs.createReadStream(filePath));
  const { data: task } = await axios.post(`${API_URL}/api/v1/clean`, form,
    { headers: { ...headers, ...form.getHeaders() } });
  console.log('Task:', task.task_id);

  // Poll
  let status = task;
  while (!['completed', 'failed'].includes(status.status)) {
    await new Promise(r => setTimeout(r, 2000));
    status = (await axios.get(`${API_URL}/api/v1/task/${task.task_id}`, { headers })).data;
  }

  // Download
  if (status.status === 'completed') {
    const pdf = await axios.get(status.download_url, { headers, responseType: 'arraybuffer' });
    fs.writeFileSync('cleaned.pdf', pdf.data);
  }
}
cleanPDF('document.pdf');

cURL

# Upload file
curl -X POST https://your-domain.com/api/v1/clean \
  -H "Authorization: Bearer pk_live_your_token" \
  -F "file=@document.pdf" \
  -F "remove_watermark=true" \
  -F "extra_ad_keywords=sponsor,advertisement"

# Check status
curl https://your-domain.com/api/v1/task/TASK_ID \
  -H "Authorization: Bearer pk_live_your_token"

# Download result
curl -o cleaned.pdf https://your-domain.com/api/v1/task/TASK_ID/download \
  -H "Authorization: Bearer pk_live_your_token"

# Clean from URL
curl -X POST https://your-domain.com/api/v1/clean-url \
  -H "Authorization: Bearer pk_live_your_token" \
  -F "url=https://example.com/document.pdf"

PHP

<?php
$apiUrl = 'https://your-domain.com';
$token = 'pk_live_your_token_here';

// Upload
$ch = curl_init("$apiUrl/api/v1/clean");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
    CURLOPT_POSTFIELDS => ['file' => new CURLFile('document.pdf')],
]);
$task = json_decode(curl_exec($ch), true);
curl_close($ch);

// Poll until done
do {
    sleep(2);
    $ch = curl_init("$apiUrl/api/v1/task/{$task['task_id']}");
    curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"]]);
    $task = json_decode(curl_exec($ch), true);
    curl_close($ch);
} while (!in_array($task['status'], ['completed', 'failed']));

// Download
if ($task['status'] === 'completed') {
    file_put_contents('cleaned.pdf',
        file_get_contents($task['download_url'], false,
            stream_context_create(['http' => ['header' => "Authorization: Bearer $token"]])));
}

Java

import java.net.http.*;
import java.nio.file.*;

var client = HttpClient.newHttpClient();
var token = "pk_live_your_token_here";
var apiUrl = "https://your-domain.com";

// Upload file
var boundary = "----Boundary" + System.currentTimeMillis();
var body = "--" + boundary + "\r\n"
    + "Content-Disposition: form-data; name=\"file\"; filename=\"doc.pdf\"\r\n"
    + "Content-Type: application/pdf\r\n\r\n";
// ... append file bytes and closing boundary ...

var req = HttpRequest.newBuilder()
    .uri(URI.create(apiUrl + "/api/v1/clean"))
    .header("Authorization", "Bearer " + token)
    .header("Content-Type", "multipart/form-data; boundary=" + boundary)
    .POST(HttpRequest.BodyPublishers.ofByteArray(fullBody))
    .build();
var resp = client.send(req, HttpResponse.BodyHandlers.ofString());
// Parse JSON response for task_id, poll status, download result

Go

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "mime/multipart"
    "net/http"
    "os"
    "time"
)

func main() {
    token := "pk_live_your_token_here"
    apiURL := "https://your-domain.com"

    // Upload
    body := &bytes.Buffer{}
    writer := multipart.NewWriter(body)
    file, _ := os.Open("document.pdf")
    part, _ := writer.CreateFormFile("file", "document.pdf")
    io.Copy(part, file)
    writer.Close()

    req, _ := http.NewRequest("POST", apiURL+"/api/v1/clean", body)
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", writer.FormDataContentType())

    resp, _ := http.DefaultClient.Do(req)
    var task map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&task)
    fmt.Println("Task:", task["task_id"])

    // Poll & download...
}