Command Line Tools (CLI)

For quick testing you can use the integrated CLI tools that ship with the Client Libraries.

All our APIs are asynchronous, as a result it's not very practical to use cURL or equivalent for quick testing.

For this reason the Client Libraries include a Command Line Interface (CLI) to allow for quick testing and debugging of your models.

Python

# Install the library
pip install mindee

# General help
mindeeV2 --help

# Help for extraction models
mindeeV2 extraction --help

# Run extraction on a file
#   --key: API key, you can instead `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   --model: Your model ID
#   Positional arg: Absolute path to the file
mindeeV2 extraction \
  --key md_XXXXXXXXXXXX \
  --model abcd1234-aa11-bb22-cc33-abcdef1234567 \
  /path/to/the/file.pdf

Node.js

Ruby

PHP

Java

.NET

We are still working hard to make the CLI utilities more complete and useful. As a result, the interface is not yet considered stable, and may be subject to change.

If you have any ideas to improve them, make a feature request!