API Reference

Authorization: Bearer YOUR_API_KEY

# -F sends the file and form fields as multipart/form-data

curl -X POST https://pdf-summarize.com/api/summarize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]" \
  -F "length=medium"

{
  "success": true,
  "summary": "A concise summary of the document.",
  "keywords": null,
  "page_count": 12,
  "original_length": 18420,
  "summary_length": 612,
  "processing_time": 4.31,
  "requests_remaining": 48
}

const streamSummary = async (file, onChunk, onDone) => {
  const form = new FormData();
  form.append('file', file);

  const res = await fetch('https://pdf-summarize.com/api/summarize?stream=1', {
    method: 'POST',
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
    body: form
  });

  const reader = res.body.getReader();
  const decoder = new TextDecoder();

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;

    const lines = decoder.decode(value).split('\n');
    for (const line of lines) {
      if (!line.startsWith('data: ')) continue;
      if (line === 'data: [DONE]') continue;
      const event = JSON.parse(line.slice(6));
      if (event.type === 'summary') onChunk(event.content);
      if (event.type === 'done')    onDone(event.summary);
    }
  }
};

// Usage
streamSummary(
  document.getElementById('pdf').files[0],
  chunk => process.stdout.write(chunk),
  full  => console.log('\n\nDone. Full summary:', full)
);

{
  "error": "Invalid API key"
}

curl -X POST https://pdf-summarize.com/api/summarize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]" \
  -F "length=short" \
  -F "style=professional" \
  -F "format=paragraph" \
  -F "outputLang=en" \
  -F "includeKeywords=true"

curl -X POST "https://pdf-summarize.com/api/summarize?stream=1" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]" \
  --no-buffer

# Output (streamed):
# data: {"type":"summary","content":"The report"}
# data: {"type":"summary","content":" outlines"}
# ...
# data: {"type":"done","summary":"Full summary text."}
# data: [DONE]

class PdfSummarizerClient {
  constructor(apiKey) {
    this.apiKey = apiKey;
    this.baseURL = 'https://pdf-summarize.com/api';
  }

  async summarize(file, options = {}) {
    const form = new FormData();
    form.append('file', file);
    for (const [k, v] of Object.entries(options)) form.append(k, v);

    const res = await fetch(`${this.baseURL}/summarize`, {
      method: 'POST',
      headers: { 'Authorization': `Bearer ${this.apiKey}` },
      body: form
    });

    if (!res.ok) {
      const err = await res.json();
      throw new Error(err.error);
    }
    return res.json();
  }
}

// Usage
const client = new PdfSummarizerClient('YOUR_API_KEY');

const result = await client.summarize(
  document.getElementById('pdf').files[0],
  { length: 'medium', style: 'professional', includeKeywords: 'true' }
);

console.log('Summary:', result.summary);
console.log('Pages:', result.page_count);
console.log('Compression:', Math.round((1 - result.summary_length / result.original_length) * 100) + '%');

import requests

class PdfSummarizerClient:
    BASE_URL = "https://pdf-summarize.com/api"

    def __init__(self, api_key: str):
        self.session = requests.Session()
        self.session.headers.update({"Authorization": f"Bearer {api_key}"})

    def summarize(self, path: str, **fields) -> dict:
        with open(path, "rb") as f:
            response = self.session.post(
                f"{self.BASE_URL}/summarize",
                files={"file": f},
                data=fields
            )
        response.raise_for_status()
        return response.json()


# Usage
client = PdfSummarizerClient("YOUR_API_KEY")

result = client.summarize(
    "report.pdf",
    length="medium",
    style="academic",
    outputLang="en",
    includeKeywords="true"
)

print(f"Summary: {result['summary']}")
print(f"Pages: {result['page_count']}")
print(f"Reduced by {100 - round(result['summary_length'] / result['original_length'] * 100)}%")

<?php

class PdfSummarizerClient {
    private string $apiKey;
    private string $baseUrl = 'https://pdf-summarize.com/api';

    public function __construct(string $apiKey) {
        $this->apiKey = $apiKey;
    }

    public function summarize(string $pdfPath, array $fields = []): array {
        $ch = curl_init($this->baseUrl . '/summarize');
        curl_setopt_array($ch, [
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_POST           => true,
            CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . $this->apiKey],
            CURLOPT_POSTFIELDS     => array_merge(
                ['file' => new CURLFile($pdfPath, 'application/pdf')],
                $fields
            ),
            CURLOPT_TIMEOUT        => 120
        ]);
        $body     = curl_exec($ch);
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);

        if ($httpCode !== 200) {
            $err = json_decode($body, true);
            throw new \RuntimeException($err['error'] ?? 'API error');
        }
        return json_decode($body, true);
    }
}

// Usage
$client = new PdfSummarizerClient('YOUR_API_KEY');

$result = $client->summarize('report.pdf', [
    'length' => 'medium',
    'includeKeywords' => 'true'
]);

echo $result['summary'] . PHP_EOL;
echo $result['page_count'] . ' pages' . PHP_EOL;