Skip to content

CLI

The kingminos CLI calls the HTTP API at https://api.kingminos.com. Same tenant Bearer as REST and MCP. See Authentication and Endpoints.

Source and issues: github.com/outboundsync/kingminos-cli. Published on npm as kingminos (0.1.0).

Auth is KINGMINOS_API_KEY — an osr_ tenant token. App-minted user tokens use the km_ prefix and are created after you sign in. --token overrides the env var. KINGMINOS_BASE_URL or --base-url overrides the host. The CLI does not store or log your key. Never print or commit the API key. Never paste a real key into these pages.

--json prints the response body only (no Next: hints). HTTP errors exit non-zero; see Exit codes.

Sign in at app.kingminos.com to mint a km_ token. Leftover access questions go to support@outboundsync.com.

Install

Section titled “Install”

Requires Node.js 20 or newer.

Terminal window
npm i -g kingminos
kingminos --help

Or run without installing:

Terminal window
npx kingminos --help
export KINGMINOS_API_KEY=osr_your_tenant_token
npx kingminos health
npx kingminos providers

Auth and host

Section titled “Auth and host”
Flag / env Meaning
--token Tenant Bearer. Overrides KINGMINOS_API_KEY.
--base-url / KINGMINOS_BASE_URL API host. Default https://api.kingminos.com. Local wrangler: http://127.0.0.1:8790.
--json Response body only (pretty JSON when applicable).
--priority speed | balance | accuracy | coverage — sets routing.path. Required on batch.
Terminal window
npx kingminos --base-url http://127.0.0.1:8790 health

A bare key is 401 malformed. Send Bearer only.

Commands

Section titled “Commands”

Commands mirror the live OpenAPI surface. Run kingminos <command> --help for request fields on that call.

Command Route
health GET /health
openapi GET /openapi.yaml
providers GET /v1/providers
capabilities GET /v1/capabilities
recipes GET /v1/recipes
company resolve POST /v1/company/resolve
company domain POST /v1/company/domain
company hierarchy POST /v1/company/hierarchy
company b2b-social POST /v1/company/b2b-social
company icon POST /v1/company/icon
company description POST /v1/company/description
person verify-employment POST /v1/person/verify-employment
person language POST /v1/person/language
person phone POST /v1/person/phone
person title POST /v1/person/title
person name POST /v1/person/name
person b2b-social POST /v1/person/b2b-social
runs get <id> GET /v1/runs/{id}
credentials put <provider> PUT /v1/credentials/{provider}
credentials delete <provider> DELETE /v1/credentials/{provider}
subjects delete <subject_key> DELETE /v1/subjects/{subject_key}
batch <company|person> <cmd> POST each JSONL/JSON-array row (--file, --priority)

company resolve is email or domain in, one company decision out. Name-only is no_decision. See Company resolve.

company b2b-social is domain in, one LinkedIn company page URL out (or null). Name-only is 400. See Company B2B social.

company icon is domain in, one hosted https://logos.kingminos.com/i/….png (or null). Name-only is 400. See Company icon.

company description is domain in, one stampable description paragraph out (or null). Name-only is 400. See Company description.

person verify-employment uses LeadMagic by default. Findymail is BYOK-only.

person name is email or LinkedIn URL in; proper-cased first, last and full name out. See Person name. person b2b-social is email in; the person’s LinkedIn profile URL out (or null). See Person B2B social.

POST /v1/company/x-account has no CLI command yet. Call it over REST.

subjects delete requires the erase scope.

batch posts each row from a JSONL file or JSON array. Example: npx kingminos batch company domain --file domains.jsonl --priority speed.

Vendor keys

Section titled “Vendor keys”

credentials put and credentials delete store and revoke vendor credentials. See Vendor keys.

Supported provider values: zoominfo, leadmagic, findymail, wiza, aiark, builtwith, prospeo, apollo, companyurlfinder, peopledatalabs, hginsights, brandfetch, enrichcrm, lemlist, snovio, cognism, lusha, starbridge, clay, databar, quickenrich, getleads, blitzapi.

Websearch is house-only — there is no credentials command for it.

LeadMagic, Wiza, Findymail, and AI Ark are house-key vendors. ZoomInfo, BuiltWith, Prospeo, Apollo, Company URL Finder, People Data Labs, HG Insights, Brandfetch, and Enrich-CRM stay BYOK via credentials put.

Credits

Section titled “Credits”

Billing is for delivered answers. The CLI prints usage.credits.spent from the response and does not hardcode prices.

Every verified work-email account gets 10 free credits a day (unused credits expire at midnight UTC). Welcome and onboarding grants last until you spend them. See Pricing for eligibility and balance rules.

Exit codes

Section titled “Exit codes”
Code Meaning
0 Success (including a business miss — HTTP 200)
1 Usage / argument error
2 Unauthorized (HTTP 401)
3 Out of credits (HTTP 402)
4 Rate limited (HTTP 429)
5 Server error (HTTP 5xx)
6 Other HTTP error

MCP and skills

Section titled “MCP and skills”

The CLI is not the MCP server and not the Agent Skills pack. MCP connects at https://mcp.kingminos.com/mcp. Skills install with npx skills add outboundsync/kingminos-skills.