Postman

A Postman collection per language, generated from the API's contract, with an environment for your key and the Collection Runner's data.

Download

File	English	Português
Collection	DocsOCR.en.postman_collection.json	DocsOCR.pt-BR.postman_collection.json
Environment	DocsOCR.en.postman_environment.json	DocsOCR.pt-BR.postman_environment.json
Collection Runner data	DocsOCR.runner-data.json

Import

1. In Postman, use Import with the collection and the environment. You can also paste each file's address.
2. Pick the DocsOCR (en) environment and paste your API key into apiKey. It stays in the environment, as a secret, never in the collection.
3. Run Start here → 1. Check the prices, which needs no key, and 2. Extract the sample certificate.

What the collection holds

• Start here: the prices and the sample certificate.
• Extraction: from a URL, from a file in base64 (in the environment's imageBase64 variable), with resizeImage, and with the fast engine.
• Refusals at no cost: no key, an unknown engine, an image below our standard, and a link that does not open.
• Reference: the document types and the API's status.

Each request has short tests: the expected status and, on a refusal, the errorCode. Each extraction sends a new requestId, and the refusals' messages come in the language of the environment's language variable.

Collection Runner

The data file has one imageUrl per row. In the Collection Runner, pick the From an image URL request, load the file and run: each row is an extraction, and each one costs credits when it returns data.