documents
Mindee CLI for Shell Scripts
Use the Mindee CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
5 functions 1 read 4 write API key auth
Mindee CLI for Shell Scripts
Call integration functions from shell scripts with stable JSON input and output.
Use shell scripts for small local automations that need one or more integration calls. The Mindee CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Mindee CLI for Shell Scripts
kosmokrator integrations:configure mindee --set api_key="$MINDEE_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call mindee.mindee_parse_invoice '{"document":"example_document","file_name":"example_file_name"}' --json Discovery Before Execution
Agents and scripts can inspect Mindee docs and schemas before choosing a function.
kosmo integrations:docs mindee --json
kosmo integrations:docs mindee.mindee_parse_invoice --json
kosmo integrations:schema mindee.mindee_parse_invoice --json
kosmo integrations:search "Mindee" --json
kosmo integrations:list --json Useful Mindee CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
mindee.mindee_parse_invoice | Write | document, file_name | Parse an invoice document (PDF or image) and extract structured data including supplier, line items, totals, dates, and tax details. |
mindee.mindee_parse_receipt | Write | document, file_name | Parse an expense receipt (PDF or image) and extract structured data including merchant, line items, totals, dates, and category. |
mindee.mindee_parse_passport | Write | document, file_name | Parse a passport document (PDF or image) and extract structured data including full name, date of birth, nationality, passport number, and expiry date. |
mindee.mindee_parse_custom | Write | endpoint_id, document, file_name | Parse a document using a custom Mindee API endpoint. Requires an endpoint_id from your custom model trained in the Mindee API builder. |
mindee.mindee_get_current_user | Read | none | Get the current authenticated Mindee user's account information — useful for verifying credentials and connection. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.