🧾 Request Parameters

Parameter	Type	Required	Description
`file`	`file`	✅ Yes (if `base64_str` is not provided)	The input image file to be processed (must be provided as a file, e.g., .jpg, .png).
`base64_str (≤ 1MB)`	`string`	✅ Yes (if `file` is not provided)	Base64-encoded string of the image file (used when sending image data directly in requests).
`prompt`	`object`	❌ Optional	A JSON string that defines the coordinates of the document's four corner points, forming a quadrilateral (example: `{"quadrilateral":[214,10,758,55,719,706,133,699]}`). If not provided, the document will be automatically detected.

✅ Successful Response Example

![image](https://aipix.net/static/examples/document-image-correction.webp)

![image](https://aipix.net/static/examples/document-image-correction2.webp)

![image](https://aipix.net/static/examples/document-image-correction3.webp)

The difference between it and the Virtual Scanner API: Virtual Scanner applies automatic enhancement based on the photo or document based on the correction.

📤 Response Example:

{
  "code": 200,
  "image": "data:image/webp;base64,...",
  "corners": {
    "quadrilateral": [
      658,
      296,
      705,
      1278,
      9,
      1280,
      7,
      384
    ]
  },
  "correction_method": "G_L_dewarp",
  "classfiy": [
    {
      "label": "document",
      "score": 0.9992
    },
    {
      "label": "photography",
      "score": 0.0008
    }
  ],
  "response_time": 1.843
}

❌ Error Responses

HTTP Code	JSON `code`	Description
422	422	Invalid input parameters.
429	429	Too many requests or timeout.
500	500	Internal server error.

📉 Error Response Format

{
  "code": <error_code>,
  "msg": "<brief error description>"
}

Example:

{
  "code": 429,
  "msg": "Too many requests."
}

📌 Notes

We strictly protect user privacy and do not store any user data.
We strive to minimize input restrictions (e.g., image size, text length), but excessive input volume may result in 429 or 500 errors.
The service operates at the maximum capacity of our servers, and we dynamically scale infrastructure to handle varying request loads.

📬 Support & Custom Deployment

For questions or support, please reach out to our team using the contact page.

We also offer dedicated server deployment for enterprise clients — a private, standalone environment that includes full API functionality with no request limits.

Pricing is based on the number of servers deployed, with each server serving at maximum throughput.

📩 Contact Us

📚 View Our API List