Scan Documents

Overview

IMG Processing API is organized around REST and ASYNC API principles.

Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies (except for file uploads), returns JSON-encoded responses, and uses standard HTTP response codes and methods.

Base URL

All URLs referenced in the documentation have the following base:

https://api.img-processing.com/v1

For a complete list of endpoints and their usage, please refer to our API Reference section.

Authentication

All API requests require authentication using your API key. Include your API key in the x-api-key header of your request.

GET /v1/files HTTP/1.1
Host: api.img-processing.com
x-api-key: YOUR_API_KEY

Check out the Authentication section for more information about how to get an API key and how to use it in your requests.

Tasks Operations

Tasks operations are any POST API call that modifies a file, and endpoints are usually described by the {resource}-operations pattern. For example, the image-operations endpoint is used to modify images, and the pdf-operations endpoint is used to modify PDFs.

Asynchronous Processing

All the operations take from a few seconds to a few minutes to complete, depending on the files and parameters involved. Due to the nature of the operations, all operations are processed asynchronously.

After you submit a request, a Task resource is created and returned in the response. You can use the id of the task to check its status and retrieve the results, or wait for the Webhook to be sent to your server when the task is completed.

Pagination

All endpoints that list objects provide support for pagination.

Check out the Pagination section for more information about how to paginate through the results.

Billing

Each month your plan includes a fixed number of operations.

The number of operations used is independent of the number of files processed. However, there are some limits on files per operations and global storage to prevent abuse.

Support

If you encounter any issues or have questions about using the Scan Documents API, please don’t hesitate to browse the API Reference for detailed information on each endpoint, or contact our support team for personalized assistance.

We’re excited to see what you’ll create with the Scan Documents API. Happy coding!

API Endpoints