Skip to main content

Overview

The Hyperbolic AgentKit uses environment variables to configure API keys, feature flags, and system settings. Variables are loaded from a .env file in the project root.

Setup

Copy the example environment file:
cp .env.example .env
Edit .env with your actual API keys and configuration.

Required Variables

Core APIs

ANTHROPIC_API_KEY
string
required
Anthropic API key for Claude LLM. Get from Anthropic Console.
CDP_API_KEY_NAME
string
required
Coinbase Developer Platform API key name. Get from CDP Portal.
CDP_API_KEY_PRIVATE
string
required
Coinbase Developer Platform private key.
HYPERBOLIC_API_KEY
string
required
Hyperbolic API key for GPU compute tools. Get from Hyperbolic Settings.

OpenAI (Required for Voice Agent)

OPENAI_API_KEY
string
OpenAI API key. Required only if using the voice agent interface. Get from OpenAI Portal.

Optional Integration APIs

Twitter/X Integration

TWITTER_ACCESS_TOKEN
string
Twitter OAuth access token.
TWITTER_API_KEY
string
Twitter API key (Consumer Key).
TWITTER_API_SECRET
string
Twitter API secret (Consumer Secret).
TWITTER_ACCESS_TOKEN_SECRET
string
Twitter OAuth access token secret.
TWITTER_BEARER_TOKEN
string
Twitter Bearer Token for API v2.
TWITTER_CLIENT_ID
string
Twitter OAuth 2.0 Client ID.
TWITTER_CLIENT_SECRET
string
Twitter OAuth 2.0 Client Secret.
Get Twitter credentials from Twitter Developer Portal.
TAVILY_API_KEY
string
Tavily API key for web search tool and Writing Agent. Get from Tavily.

LangChain Tracing

LANGCHAIN_TRACING_V2
boolean
default:"true"
Enable LangChain tracing for debugging.
LANGCHAIN_ENDPOINT
string
LangChain API endpoint URL.
LANGCHAIN_API_KEY
string
LangChain API key.
LANGCHAIN_PROJECT
string
LangChain project name.

Configuration Variables

SSH Configuration

SSH_PRIVATE_KEY_PATH
string
default:"~/.ssh/id_rsa"
Path to SSH private key for GPU instance access. Must be an RSA key (ed25519 not supported).Generate an RSA key:
ssh-keygen -t rsa -b 4096 -C "[email protected]"
Add public key to Hyperbolic Settings.

Character Configuration

CHARACTER_FILE
string
default:"characters/default.json"
Path to character configuration JSON file. Can be comma-separated for multiple characters.

Knowledge Base Configuration

USE_TWITTER_KNOWLEDGE_BASE
boolean
default:"false"
Enable Twitter knowledge base for scraping KOL tweets. At least one knowledge base (Twitter or Podcast) must be enabled.
USE_PODCAST_KNOWLEDGE_BASE
boolean
default:"true"
Enable Podcast knowledge base for transcript processing.

Security Settings

ALLOW_DANGEROUS_REQUEST
boolean
default:"true"
Allow HTTP request tools. Must be true to use request tools. Set to false in production for security.

Feature Flags

Core Toolkits

USE_COINBASE_TOOLS
boolean
default:"true"
Enable Coinbase CDP tools for blockchain operations.
USE_HYPERBOLIC_TOOLS
boolean
default:"true"
Enable Hyperbolic GPU compute tools.
USE_TWITTER_CORE
boolean
default:"true"
Enable core Twitter API integration.
USE_BROWSER_TOOLS
boolean
default:"true"
Enable browser automation tools (Playwright). Recommended for maximum agent functionality.

Twitter Tools

USE_TWEET_REPLY_TRACKING
boolean
default:"true"
Enable tracking of replied tweets to avoid duplicates.
USE_TWEET_REPOST_TRACKING
boolean
default:"true"
Enable tracking of reposted tweets.
USE_TWEET_DELETE
boolean
default:"true"
Enable tweet deletion capability.
USE_USER_ID_LOOKUP
boolean
default:"true"
Enable Twitter user ID lookup by username.
USE_USER_TWEETS_LOOKUP
boolean
default:"true"
Enable retrieving user’s recent tweets.
USE_RETWEET
boolean
default:"true"
Enable retweet functionality.

Additional Tools

USE_DEPLOY_MULTITOKEN
boolean
default:"true"
Enable multi-token deployment tools.
Enable web search via DuckDuckGo.
USE_REQUEST_TOOLS
boolean
default:"true"
Enable HTTP request tools. Requires ALLOW_DANGEROUS_REQUEST=true.
USE_WRITING_AGENT
boolean
default:"true"
Enable Writing Agent for content generation.
USE_GITHUB_TOOLS
boolean
default:"true"
Enable GitHub API tools. Requires GITHUB_TOKEN.

Example .env File

# Core APIs (Required)
ANTHROPIC_API_KEY=sk-ant-...
CDP_API_KEY_NAME=organizations/.../apiKeys/...
CDP_API_KEY_PRIVATE=-----BEGIN EC PRIVATE KEY-----\n...\n-----END EC PRIVATE KEY-----\n
HYPERBOLIC_API_KEY=hb_...

# OpenAI (Required for voice agent)
OPENAI_API_KEY=sk-...

# Twitter Integration (Optional)
TWITTER_ACCESS_TOKEN=...
TWITTER_API_KEY=...
TWITTER_API_SECRET=...
TWITTER_ACCESS_TOKEN_SECRET=...
TWITTER_BEARER_TOKEN=...
TWITTER_CLIENT_ID=...
TWITTER_CLIENT_SECRET=...

# Web Search
TAVILY_API_KEY=tvly-...

# SSH Configuration
SSH_PRIVATE_KEY_PATH=~/.ssh/id_rsa

# LangChain Configuration
LANGCHAIN_TRACING_V2=true
LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
LANGCHAIN_API_KEY=...
LANGCHAIN_PROJECT=hyperbolic-agent

# Character Configuration
CHARACTER_FILE=characters/default.json

# Knowledge Base Configuration
USE_TWITTER_KNOWLEDGE_BASE=false
USE_PODCAST_KNOWLEDGE_BASE=true

# Security Settings
ALLOW_DANGEROUS_REQUEST=true

# Core Toolkits
USE_COINBASE_TOOLS=true
USE_HYPERBOLIC_TOOLS=true
USE_TWITTER_CORE=true
USE_BROWSER_TOOLS=true

# Twitter Tools
USE_TWEET_REPLY_TRACKING=true
USE_TWEET_REPOST_TRACKING=true
USE_TWEET_DELETE=true
USE_USER_ID_LOOKUP=true
USE_USER_TWEETS_LOOKUP=true
USE_RETWEET=true

# Additional Tools
USE_DEPLOY_MULTITOKEN=true
USE_WEB_SEARCH=true
USE_REQUEST_TOOLS=true
USE_WRITING_AGENT=true

Security Best Practices

  1. Never commit .env to version control
    • Add .env to .gitignore
    • Use .env.example as a template (without actual keys)
  2. Restrict file permissions
    chmod 600 .env
    
  3. Use different keys for development and production
  4. Rotate API keys regularly
  5. Set ALLOW_DANGEROUS_REQUEST=false in production if request tools aren’t needed

Build docs developers (and LLMs) love