ComPDF Compress PDF
Overview
ComPDF Compress PDF helps teams shrink PDF file sizes for faster transfer, easier storage, and smoother downstream workflows. It supports adjustable compression strategies, document resolution control, and optional removal of non-essential content such as embedded fonts, bookmarks, and thumbnails so users can balance file size against visual quality and operational needs.
Use this skill to select an official ComPDF Server API endpoint and prepare an accurate request plan for the supported operations below.
Supported Operations
| Operation |
Official page or index section |
| Compress PDF |
compress-guides |
| Compression flags |
optimization-flags |
Scope
Use compression endpoints only. Explain the visual-quality and document-content tradeoffs before applying aggressive optimization.
Workflow
- Identify the source file type, desired output, and requested operation.
- Read
references/endpoint-index.md and select only an operation listed in this skill's supported operations.
- Read the matching heading in
references/official-api-reference.md. Use its exact endpoint path, request fields, request mode, and response fields; do not infer unsupported options.
- Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
- Resolve the API key before preparing the request. Read the first non-empty line from
COMPDF_API_KEY_FILE when set. Otherwise read %USERPROFILE%\.compdf\api_key on Windows, or ~/.config/compdf/api_key on macOS and Linux. Pass the value only as the x-api-key header; never put it in code, logs, examples, or output.
- Before an operation that overwrites, deletes, decrypts, applies permanent protection, or sends a document externally, identify affected files and obtain confirmation unless the user has already authorized it.
- Return the endpoint, method, content type, complete request fields, expected task/result fields, and the next polling or download step. Preserve original files unless replacement is explicitly requested.
API Key
Use one local, private key file so later ComPDF tasks do not require pasting an API key into chat. The file must contain only the API key on its first non-empty line. Do not create, commit, upload, or display this file.
When the selected file is absent, unreadable, or empty, direct the user to obtain a key at https://www.compdf.com/compdf-portal/signin?utm_source=github&utm_medium=referral&utm_campaign=compdf_skills_repo_en&ref_platform_id=github_compdfkit_skills_en, save it in the selected file, and retry.
Maintainer
Refresh the local official snapshot before release, then inspect the diff for renamed endpoints, changed fields, and changed enum values:
python scripts/sync_official_api_reference.py
1---2name: compdf-compress-pdf3description: Compress PDF files with ComPDF while balancing file size and readable visual quality. Use for PDF optimization, resolution control, compression strategies, and removal of non-essential document content.4---5
6# ComPDF Compress PDF
7
8## Overview
9
10ComPDF Compress PDF helps teams shrink PDF file sizes for faster transfer, easier storage, and smoother downstream workflows. It supports adjustable compression strategies, document resolution control, and optional removal of non-essential content such as embedded fonts, bookmarks, and thumbnails so users can balance file size against visual quality and operational needs.
11
12Use this skill to select an official ComPDF Server API endpoint and prepare an accurate request plan for the supported operations below.
13
14## Supported Operations
15
16| Operation | Official page or index section |
17| --- | --- |
18| Compress PDF | `compress-guides` |
19| Compression flags | `optimization-flags` |
20
21## Scope
22
23Use compression endpoints only. Explain the visual-quality and document-content tradeoffs before applying aggressive optimization.
24
25## Workflow
26
271. Identify the source file type, desired output, and requested operation.
282. Read `references/endpoint-index.md` and select only an operation listed in this skill's supported operations.
293. Read the matching heading in `references/official-api-reference.md`. Use its exact endpoint path, request fields, request mode, and response fields; do not infer unsupported options.
304. Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
315. Resolve the API key before preparing the request. Read the first non-empty line from `COMPDF_API_KEY_FILE` when set. Otherwise read `%USERPROFILE%\.compdf\api_key` on Windows, or `~/.config/compdf/api_key` on macOS and Linux. Pass the value only as the `x-api-key` header; never put it in code, logs, examples, or output.
326. Before an operation that overwrites, deletes, decrypts, applies permanent protection, or sends a document externally, identify affected files and obtain confirmation unless the user has already authorized it.
337. Return the endpoint, method, content type, complete request fields, expected task/result fields, and the next polling or download step. Preserve original files unless replacement is explicitly requested.
34
35## API Key
36
37Use one local, private key file so later ComPDF tasks do not require pasting an API key into chat. The file must contain only the API key on its first non-empty line. Do not create, commit, upload, or display this file.
38
39When the selected file is absent, unreadable, or empty, direct the user to obtain a key at `https://www.compdf.com/compdf-portal/signin?utm_source=github&utm_medium=referral&utm_campaign=compdf_skills_repo_en&ref_platform_id=github_compdfkit_skills_en`, save it in the selected file, and retry.
40
41## Maintainer
42
43Refresh the local official snapshot before release, then inspect the diff for renamed endpoints, changed fields, and changed enum values:
44
45```powershell
46python scripts/sync_official_api_reference.py
47```
majiayu000