PaperClean API
Document image cleanup and enhancement API. PaperClean removes shadows, fixes contrast, corrects perspective, and produces clean, high-quality scans from…
Developer tools#documents--productivity
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Document image cleanup and enhancement API. PaperClean removes shadows, fixes contrast, corrects perspective, and produces clean, high-quality scans from photos of documents taken with any camera or phone.
Features:
- 2-pass enhancement for superior quality (shadows removed, contrast optimized)
- Perspective correction with 4-corner coordinates
- Configurable pipeline (combine crop + enhance in one call)
- Fast processing powered by Rust backend
- Multiple formats supported: JPG, PNG, WebP, TIFF
Endpoints 6
Processing
- POSTFull document cleanup
/api/v1/cleanApplies the full PaperClean pipeline: 2-pass enhancement that removes shadows, fixes contrast and produces a clean document scan. This is the recommended… - POSTPerspective correction
/api/v1/cropCorrects perspective distortion using 4-corner coordinates. Provide the coordinates of the document corners as fractions (0-1) relative to image dimensions.… - POSTConfigurable pipeline
/api/v1/pipelineCombines crop and enhance in a single call. The pipeline first applies perspective correction (if coordinates are provided), then enhancement. Use passes=0 to…
Account
- GETCheck usage and limits
/api/v1/usageReturns your current plan, usage count, remaining requests, and period end date. - POSTRegister for a free API key
/api/v1/registerSelf-service registration. Provide your email to get a free API key with 50 images/month. If a key already exists for the email, it returns the existing key.
System
- GETHealth check
/api/healthReturns API health status and system checks.
API details
- Base URL
https://paperclean.ip1.cc- Authentication
- An API key in the X-API-Key header
- Operations
- 6 operations on 6 pathsPOST 4GET 2
- Main resources
- Processing 3Account 2System 1
- Response formats
application/jsonimage/jpeg- Description format
- OpenAPI 3.0.3, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Ip1's published OpenAPI description
How to test the PaperClean API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the PaperClean API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Full document cleanup” (POST /api/v1/clean), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the PaperClean API?
Document image cleanup and enhancement API. PaperClean removes shadows, fixes contrast, corrects perspective, and produces clean, high-quality scans from… It is listed under Developer tools and has 6 endpoints.
Who publishes the PaperClean API?
It is listed from Ip1's public API description (an OpenAPI document), not published by Ip1 on Swastik Codes. Anyone who controls paperclean.ip1.cc can claim the profile by adding a DNS TXT record.
What is the base URL of the PaperClean API?
Requests go to https://paperclean.ip1.cc. Endpoint paths are added to this base URL.
How do I authenticate with the PaperClean API?
With an API key in the X-API-Key header.
How many endpoints does the PaperClean API have?
6 operations on 6 paths (4 POST, 2 GET). The largest groups are Processing, Account, System.
Is forking the PaperClean API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.