KosmoKrator

documents

Mindee CLI for AI Agents

Use the Mindee CLI from KosmoKrator to call Mindee tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

5 functions 1 read 4 write API key auth

Mindee CLI Setup

Mindee can be configured headlessly with `kosmokrator integrations:configure mindee`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure mindee --set api_key="$MINDEE_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor mindee --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

KeyEnv varTypeRequiredLabel
api_key MINDEE_API_KEY Secret secret yes API Key
url MINDEE_URL URL url no API Base URL

Call Mindee Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call mindee.mindee_parse_invoice '{
  "document": "example_document",
  "file_name": "example_file_name"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:mindee mindee_parse_invoice '{
  "document": "example_document",
  "file_name": "example_file_name"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities 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

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Mindee.

mindee.mindee_parse_invoice

Write write

Parse an invoice document (PDF or image) and extract structured data including supplier, line items, totals, dates, and tax details.

Parameters
document, file_name

Generic CLI call

kosmo integrations:call mindee.mindee_parse_invoice '{"document":"example_document","file_name":"example_file_name"}' --json

Provider shortcut

kosmo integrations:mindee mindee_parse_invoice '{"document":"example_document","file_name":"example_file_name"}' --json

mindee.mindee_parse_receipt

Write write

Parse an expense receipt (PDF or image) and extract structured data including merchant, line items, totals, dates, and category.

Parameters
document, file_name

Generic CLI call

kosmo integrations:call mindee.mindee_parse_receipt '{"document":"example_document","file_name":"example_file_name"}' --json

Provider shortcut

kosmo integrations:mindee mindee_parse_receipt '{"document":"example_document","file_name":"example_file_name"}' --json

mindee.mindee_parse_passport

Write write

Parse a passport document (PDF or image) and extract structured data including full name, date of birth, nationality, passport number, and expiry date.

Parameters
document, file_name

Generic CLI call

kosmo integrations:call mindee.mindee_parse_passport '{"document":"example_document","file_name":"example_file_name"}' --json

Provider shortcut

kosmo integrations:mindee mindee_parse_passport '{"document":"example_document","file_name":"example_file_name"}' --json

mindee.mindee_parse_custom

Write write

Parse a document using a custom Mindee API endpoint. Requires an endpoint_id from your custom model trained in the Mindee API builder.

Parameters
endpoint_id, document, file_name

Generic CLI call

kosmo integrations:call mindee.mindee_parse_custom '{"endpoint_id":"example_endpoint_id","document":"example_document","file_name":"example_file_name"}' --json

Provider shortcut

kosmo integrations:mindee mindee_parse_custom '{"endpoint_id":"example_endpoint_id","document":"example_document","file_name":"example_file_name"}' --json

mindee.mindee_get_current_user

Read read

Get the current authenticated Mindee user's account information — useful for verifying credentials and connection.

Parameters
none

Generic CLI call

kosmo integrations:call mindee.mindee_get_current_user '{}' --json

Provider shortcut

kosmo integrations:mindee mindee_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

mindee.mindee_parse_invoice

Parse an invoice document (PDF or image) and extract structured data including supplier, line items, totals, dates, and tax details.

Operation
Write write
Schema command
kosmo integrations:schema mindee.mindee_parse_invoice --json
ParameterTypeRequiredDescription
document string yes The document to parse — either a file path or a base64-encoded string of the file content.
file_name string no Optional filename for the document (used when providing base64 content).

mindee.mindee_parse_receipt

Parse an expense receipt (PDF or image) and extract structured data including merchant, line items, totals, dates, and category.

Operation
Write write
Schema command
kosmo integrations:schema mindee.mindee_parse_receipt --json
ParameterTypeRequiredDescription
document string yes The receipt document to parse — either a file path or a base64-encoded string of the file content.
file_name string no Optional filename for the document (used when providing base64 content).

mindee.mindee_parse_passport

Parse a passport document (PDF or image) and extract structured data including full name, date of birth, nationality, passport number, and expiry date.

Operation
Write write
Schema command
kosmo integrations:schema mindee.mindee_parse_passport --json
ParameterTypeRequiredDescription
document string yes The passport document to parse — either a file path or a base64-encoded string of the file content.
file_name string no Optional filename for the document (used when providing base64 content).

mindee.mindee_parse_custom

Parse a document using a custom Mindee API endpoint. Requires an endpoint_id from your custom model trained in the Mindee API builder.

Operation
Write write
Schema command
kosmo integrations:schema mindee.mindee_parse_custom --json
ParameterTypeRequiredDescription
endpoint_id string yes The custom endpoint ID from your Mindee dashboard (e.g., "username/endpoint_name/v1").
document string yes The document to parse — either a file path or a base64-encoded string of the file content.
file_name string no Optional filename for the document (used when providing base64 content).

mindee.mindee_get_current_user

Get the current authenticated Mindee user's account information — useful for verifying credentials and connection.

Operation
Read read
Schema command
kosmo integrations:schema mindee.mindee_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.