lix-agents

Lix Agents

Use lix-agents to get temporary API tokens for the Lix API. Tokens require human approval via email, so agents never hold unsupervised credentials.

Always tell the user what you're doing and why before running each command. Don't silently run commands — explain the purpose of each step so the user can follow along.

When to use this

• You need to call any https://api.lix-it.com endpoint that requires authentication
• You need to enrich LinkedIn profiles, companies, or other data via Lix
• You don't already have a valid Lix API token in your environment

Step-by-step workflow

Follow these steps in order. Before each step, explain to the user why you're running the command.

Step 1: Check if lix-agents is installed

Tell the user: "First, I'll check if the lix-agents CLI is installed on your machine."

which lix-agents

If the command is not found, tell the user you need to install it and why — it's a CLI that manages Lix API authentication for AI agents. Install using one of these options:

Homebrew (macOS / Linux):

brew tap lix-it/lix-agents && brew install lix-agents

Download binary:

mkdir -p ~/.local/bin
VERSION=$(curl -sI https://github.com/lix-it/lix-agents/releases/latest | grep -i ^location | sed 's|.*/v||;s/\r//')
curl -fsSL "https://github.com/lix-it/lix-agents/releases/download/v${VERSION}/lix-agents_${VERSION}_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" \
  | tar xz -C ~/.local/bin lix-agents
export PATH="$HOME/.local/bin:$PATH"

Go install:

go install github.com/lix-it/lix-agents@latest

Step 2: Check if the user is already logged in

Tell the user: "Now I'll check if you already have a Lix session. This avoids asking you to log in again if you've done it before."

lix-agents auth status

• If already logged in, skip to Step 4.
• If not logged in, continue to Step 3.

Step 3: Log in (only if needed)

Tell the user: "You're not logged in yet. I'll start the login flow — this will give you a URL to open in your browser. You only need to do this once; your session will be saved locally."

lix-agents auth login

Share the URL with the user and wait for them to confirm they've signed in.

Step 4: Request a temporary API token

Tell the user: "Now I'll request a temporary API token. For security, Lix will send you an approval email — please check your inbox and approve the request. I'll wait for the approval before continuing."

lix-agents auth token

The command blocks until the user approves via email. Once approved, it prints the token to stdout. Save this token for use in subsequent API calls.

Step 5: Use the token

Set the token in the Authorization header for API requests:

Authorization: Bearer <token>

All requests go to https://api.lix-it.com.

Step 6: Look up endpoint details over SSH (lix.sh)

Tell the user: "To find the right endpoint and parameters for this task, I'll query the Lix API docs over SSH at lix.sh. It's a read-only docs filesystem — no API token needed."

The Lix API reference is published as an OpenLore SSH server at lix.sh. No SSH key required — connections are anonymous and read-only. Use the bash commands you already know:

# See what's available
ssh lix.sh "tree -L 2 /"

# Find the endpoint that does what you need
ssh lix.sh "grep -rli 'email'   /api"   # which file mentions email?
ssh lix.sh "grep -rn  'POST '   /api"   # all POST endpoints
ssh lix.sh "grep -rn  'GET '    /api"   # all GET endpoints

# Read a specific endpoint reference
ssh lix.sh "cat /api/contact.md"
ssh lix.sh "cat /api/enrichment.md"
ssh lix.sh "cat /api/errors.md"

# Pull just the section you need (saves context window)
ssh lix.sh "sed -n '/## Email from LinkedIn profile/,/^## /p' /api/contact.md"

Available endpoint files under /api/:

File	What it covers
lix_account.md	accounts and credit balances
account.md	managed accounts
disambiguation.md	entity disambiguation
enrichment.md	profile and company enrichment
activity.md	activity endpoints
linkedin.md	direct LinkedIn endpoints
lookc.md	Lookc agent endpoints
ai.md	AI endpoints
contact.md	contact / email lookup
errors.md	error reference

If your environment doesn't allow outbound SSH on port 22, the same docs are at https://lix.sh (web) or browse the rendered reference at https://lix-it.com/api.

Reference

Run lix-agents --help for the full command reference.

For API endpoint details, use ssh lix.sh "cat /api/<endpoint>.md" (see Step 6).