Home/Documentation

// DOCUMENTATION

Developer Documentation

Everything you need to integrate Hypen's zero-trust proxy, VaR Firewall, and Escrow Engine into your autonomous agent stack.

Quick Start

Getting Started in Under 5 Minutes

Hypen works as a transparent drop-in proxy between your agent runtime and external APIs. You do not need to refactor your agent logic — just re-route outbound traffic through your assigned Hypen endpoint.

Prerequisites: A Hypen workspace ID and API key. Obtain both from the Dashboard.

Step 1 — Set your proxy endpoint

Replace outbound base URLs in your agent configuration with your Hypen proxy URL:

bash
# Export your proxy credentials export HYPEN_PROXY_URL="https://proxy.hypen.network/v1/{workspace_id}" export HYPEN_API_KEY="hpn_live_..."

Step 2 — Route agent traffic

Point your agent's HTTP client at the proxy. For OpenAI-compatible runtimes:

python
import openai import os client = openai.OpenAI( api_key=os.environ["OPENAI_API_KEY"], http_client=openai.DefaultHttpxClient( proxy=os.environ["HYPEN_PROXY_URL"], ), )

Step 3 — Verify interception

Open your Dashboard and navigate to Intercept Feed. You should see your agent's first proxied request appear within seconds.

Configuration

VaR Firewall Configuration

The Value at Risk Firewall is configured per-agent. Each agent profile specifies spend limits, velocity caps, and breach actions.

json
{ "agent_id": "agent:orchestrator-7", "var_profile": { "confidence": 0.99, "daily_limit_usd": 10000, "velocity_cap_per_min": 500, "breach_action": "block_and_alert" }, "escrow": { "enabled": true, "release_conditions": ["multi_party_sign", "time_lock_1h"] } }
SDKs

Client Libraries

Official Hypen SDKs are available for all major agent runtimes. Community libraries are welcome via pull request.

  • Python SDK — pip install hypen-sdk
  • Node.js SDK — npm install @hypen/sdk
  • LangChain integration — pre-built callback handler
  • AutoGen middleware — drop-in proxy wrapper
  • CrewAI tool adapter — native crew agent support
SDK documentation is under active development. For early access, contact hello@hypen.network.
Audit Logs

Immutable Audit Trail

Every intercepted request generates a tamper-proof audit record. Records are append-only, cryptographically signed, and retained for a minimum of 7 years to satisfy enterprise compliance requirements.

Audit logs are exportable in JSON, CSV, and SIEM-compatible formats. Webhook delivery is available for real-time SIEM integration.

  • Full request/response payload capture (configurable redaction)
  • Agent identity, credential state, and mTLS certificate fingerprint
  • VaR score computed at time of intercept
  • Escrow vault state at time of transaction
  • Breach events and kill-switch activations