Hippocortex/Docs
GitHubDashboard

Installation

This page covers all the ways to install and configure the Hippocortex SDK. Choose the method that fits your stack.

JavaScript / TypeScript

The TypeScript SDK is published as @hippocortex/sdk on npm. It requires Node.js 18 or later (uses native fetch).

npm install @hippocortex/sdk
# or
pnpm add @hippocortex/sdk
# or
yarn add @hippocortex/sdk

Python

The Python SDK is published as hippocortex on PyPI. It requires Python 3.10 or later and uses httpx for async HTTP.

pip install hippocortex

Optional Dependencies

Framework adapters have optional dependencies. Install only what you need:

pip install hippocortex[openai-agents]      # OpenAI Agents adapter
pip install hippocortex[langgraph]   # LangGraph adapter
pip install hippocortex[crewai]      # CrewAI adapter
pip install hippocortex[autogen]     # AutoGen adapter
pip install hippocortex    # OpenClaw adapter
pip install hippocortex[all]         # All adapters

Configuration

The SDK resolves configuration in this order (first match wins):

  1. Constructor arguments passed directly to Hippocortex() or wrap()
  2. Environment variables (HIPPOCORTEX_API_KEY, HIPPOCORTEX_BASE_URL)
  3. Config file (.hippocortex.json in the project root)

Environment Variables

VariableDescriptionDefault
HIPPOCORTEX_API_KEYYour API key (hx_live_* or hx_test_*)Required
HIPPOCORTEX_BASE_URLAPI base URLhttps://api.hippocortex.dev
HIPPOCORTEX_SILENTSet to 1 to suppress console output0

Config File

Create a .hippocortex.json in your project root:

{
  "apiKey": "hx_test_your_key_here",
  "baseUrl": "https://api.hippocortex.dev"
}

Add .hippocortex.json to your .gitignore to avoid committing API keys.

API Key Types

PrefixEnvironmentBillingUse For
hx_test_*TestNo billingDevelopment, CI, staging
hx_live_*ProductionBilledProduction workloads

Test and production environments are completely isolated. Data captured with a test key is never visible to production keys and vice versa.

Verifying Your Installation

TypeScript:

import { Hippocortex } from '@hippocortex/sdk'

const hx = new Hippocortex()
const result = await hx.synthesize({ query: 'test' })
console.log('Connected:', result.ok)

Python:

import asyncio
from hippocortex import Hippocortex

async def main():
    hx = Hippocortex()
    result = await hx.synthesize(query="test")
    print("Connected:", result.ok)

asyncio.run(main())

Next Steps