KosmoKrator

data

Clearbit CLI for AI Agents

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

Clearbit CLI Setup

Clearbit can be configured headlessly with `kosmokrator integrations:configure clearbit`.

Install, configure, and verify
# 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 clearbit --set api_key="$CLEARBIT_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor clearbit --json
kosmokrator integrations:status --json

Credentials

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

KeyEnv varTypeRequiredLabel
api_key CLEARBIT_API_KEY Secret secret yes API Key
url CLEARBIT_URL URL url no Person API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call clearbit.clearbit_api_get '{"api":"example_api","path":"example_path","params":"example_params"}' --json
Provider shortcut
kosmo integrations:clearbit clearbit_api_get '{"api":"example_api","path":"example_path","params":"example_params"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs clearbit --json
kosmo integrations:docs clearbit.clearbit_api_get --json
kosmo integrations:schema clearbit.clearbit_api_get --json
kosmo integrations:search "Clearbit" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

clearbit.clearbit_api_get

Call a read-only Clearbit GET endpoint on a named API host such as person, company, reveal, prospector, discovery, risk, name_to_domain, or autocomplete.

Read read
Parameters
api, path, params
Generic call
kosmo integrations:call clearbit.clearbit_api_get '{"api":"example_api","path":"example_path","params":"example_params"}' --json
Shortcut
kosmo integrations:clearbit clearbit_api_get '{"api":"example_api","path":"example_path","params":"example_params"}' --json

clearbit.clearbit_calculate_risk

Calculate a Clearbit Risk score from email, IP, and optional identity fields. This is a legacy unsupported API for existing Clearbit customers.

Read read
Parameters
params
Generic call
kosmo integrations:call clearbit.clearbit_calculate_risk '{"params":"example_params"}' --json
Shortcut
kosmo integrations:clearbit clearbit_calculate_risk '{"params":"example_params"}' --json

clearbit.clearbit_discovery_search

Search Clearbit Discovery companies using a query and optional pagination parameters.

Read read
Parameters
params
Generic call
kosmo integrations:call clearbit.clearbit_discovery_search '{"params":"example_params"}' --json
Shortcut
kosmo integrations:clearbit clearbit_discovery_search '{"params":"example_params"}' --json

clearbit.clearbit_enrich_combined

Look up a person and associated company by email using Clearbit combined enrichment.

Read read
Parameters
email
Generic call
kosmo integrations:call clearbit.clearbit_enrich_combined '{"email":"example_email"}' --json
Shortcut
kosmo integrations:clearbit clearbit_enrich_combined '{"email":"example_email"}' --json

clearbit.clearbit_enrich_company

Look up a company by domain name using Clearbit. Returns company metrics, industry categorization, social profiles, and funding data when available.

Read read
Parameters
domain
Generic call
kosmo integrations:call clearbit.clearbit_enrich_company '{"domain":"example_domain"}' --json
Shortcut
kosmo integrations:clearbit clearbit_enrich_company '{"domain":"example_domain"}' --json

clearbit.clearbit_enrich_person

Look up a person by email address using Clearbit. Returns social profiles, employment, location, and demographic data when available.

Read read
Parameters
email
Generic call
kosmo integrations:call clearbit.clearbit_enrich_person '{"email":"example_email"}' --json
Shortcut
kosmo integrations:clearbit clearbit_enrich_person '{"email":"example_email"}' --json

clearbit.clearbit_list_autocomplete

Search for companies by name using Clearbit Autocomplete. Returns a list of matching companies with domains, logos, and descriptions. Useful for type-ahead search.

Read read
Parameters
name
Generic call
kosmo integrations:call clearbit.clearbit_list_autocomplete '{"name":"example_name"}' --json
Shortcut
kosmo integrations:clearbit clearbit_list_autocomplete '{"name":"example_name"}' --json

clearbit.clearbit_name_to_domain

Find a company domain and logo by company name using Clearbit Name to Domain. This is a legacy unsupported API for existing Clearbit customers.

Read read
Parameters
name
Generic call
kosmo integrations:call clearbit.clearbit_name_to_domain '{"name":"example_name"}' --json
Shortcut
kosmo integrations:clearbit clearbit_name_to_domain '{"name":"example_name"}' --json

clearbit.clearbit_prospect

Find people by job title and/or company name using Clearbit Prospecting. Returns names, titles, and email addresses when available.

Read read
Parameters
domain, title, role, roles, seniority, company, page
Generic call
kosmo integrations:call clearbit.clearbit_prospect '{"domain":"example_domain","title":"example_title","role":"example_role","roles":"example_roles","seniority":"example_seniority","company":"example_company","page":1}' --json
Shortcut
kosmo integrations:clearbit clearbit_prospect '{"domain":"example_domain","title":"example_title","role":"example_role","roles":"example_roles","seniority":"example_seniority","company":"example_company","page":1}' --json

clearbit.clearbit_reveal

Identify the company behind an IP address using Clearbit Reveal.

Read read
Parameters
ip
Generic call
kosmo integrations:call clearbit.clearbit_reveal '{"ip":"example_ip"}' --json
Shortcut
kosmo integrations:clearbit clearbit_reveal '{"ip":"example_ip"}' --json

Function Schemas

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

clearbit.clearbit_api_get 3 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_api_get --json
ParameterTypeRequiredDescription
api string yes API host key: person, company, reveal, prospector, discovery, risk, name_to_domain, or autocomplete.
path string yes Relative endpoint path such as /companies/find.
params object no Query parameters.
clearbit.clearbit_calculate_risk 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_calculate_risk --json
ParameterTypeRequiredDescription
params object yes Risk inputs such as email, ip, name, country_code, zip_code, given_name, family_name.
clearbit.clearbit_enrich_combined 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_enrich_combined --json
ParameterTypeRequiredDescription
email string yes Email address to enrich.
clearbit.clearbit_enrich_company 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_enrich_company --json
ParameterTypeRequiredDescription
domain string yes The company domain to look up (e.g., "example.test").
clearbit.clearbit_enrich_person 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_enrich_person --json
ParameterTypeRequiredDescription
email string yes The email address of the person to look up (e.g., "person@example.test").
clearbit.clearbit_list_autocomplete 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_list_autocomplete --json
ParameterTypeRequiredDescription
name string yes Company name or prefix to search for (e.g., "Stripe", "Goo").
clearbit.clearbit_name_to_domain 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_name_to_domain --json
ParameterTypeRequiredDescription
name string yes Company name, such as Segment.
clearbit.clearbit_prospect 7 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_prospect --json
ParameterTypeRequiredDescription
domain string no Company domain to search within (e.g., "example.test").
title string no Job title to search for (e.g., "CEO", "Software Engineer", "VP of Sales").
role string no Role filter such as sales or engineering.
roles string no Comma-separated role filters.
seniority string no Seniority filter such as executive, manager, or individual_contributor.
company string no Company name to filter by (e.g., "Stripe", "Google").
page integer no Page number for pagination (default: 1).
clearbit.clearbit_reveal 1 parameters
Schema command
kosmo integrations:schema clearbit.clearbit_reveal --json
ParameterTypeRequiredDescription
ip string yes The IP address to look up (IPv4 or IPv6, e.g., "203.0.113.10").

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.