Use the right interface. Use the API when your app calls Hoist directly. Use MCP when an AI host needs OAuth consent. Use the CLI when you want shell commands.
Auth
CLI calls use a Hoist Assets API key. Pass it with --token or set HOIST_ASSETS_API_KEY.
export HOIST_ASSETS_API_KEY=<api_key>Use the same API key you use for REST calls. You do not create a separate CLI credential. OAuth access tokens can still be passed with --token for delegated flows.
Commands
| Command | Use it for | API route |
|---|---|---|
hoist health | Check the API host. | GET /v1/_health |
hoist abn lookup <abn> | Check an ABN. | GET /v1/abn/{abn} |
hoist ppsr preview <subject> | Preview a PPSR search before a paid run. | POST /v1/ppsr/preview |
hoist ppsr search <subject> | Run a PPSR organisation or serial-number search after paid source access is enabled. | POST /v1/ppsr/search |
hoist receipts get | Read logs for completed checks. | GET /v1/receipts/due-diligence |
Examples
hoist health --base-url https://api.assets.hoistai.com
hoist abn lookup 11695718659 --json
hoist ppsr preview 123456789 --json
hoist ppsr search 123456789 --purpose "counterparty check" --json
# Requires paid source access.When to use the CLI
- Run checks from CI.
- Debug a request before wiring it into an app.
- Let a local agent call Hoist through shell commands.
- Export logs or records from a script.