// API REFERENCE

REST API Reference

The Hypen API is organized around REST principles with predictable, resource-oriented URLs and standard HTTP response codes. All requests and responses are encoded in JSON.

Authentication

All API requests must include your Hypen API key in the Authorization header using Bearer token format. Keys are scoped per-workspace and can be rotated from the Dashboard.

http
Authorization: Bearer hpn_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Base URL: https://api.hypen.network/v1

Endpoints

Core Endpoints

The following endpoints cover the primary Hypen control plane. Data plane traffic (proxied agent requests) flows through your assigned proxy URL, not this API.

Method	Endpoint	Description
GET	`/agents`	List all agent profiles in the workspace.
POST	`/agents`	Create a new agent profile with VaR configuration.
GET	`/agents/{id}`	Retrieve an agent profile by ID.
POST	`/agents/{id}/kill`	Immediately terminate all proxied activity for this agent.
GET	`/intercepts`	Paginated log of intercepted requests.
GET	`/intercepts/{id}`	Full payload and VaR details for a single intercept.
GET	`/vaults`	List all active escrow vaults.
POST	`/vaults/{id}/release`	Submit release approval for a vault (multi-party flows).
GET	`/var/snapshot`	Real-time VaR snapshot for the workspace portfolio.
GET	`/audit/export`	Export audit logs in JSON, CSV, or NDJSON format.

Response Codes

HTTP Response Codes

Hypen returns standard HTTP status codes. Errors always include a machine-readable code field and a human-readable message.

Code	Meaning
`200`	Request succeeded.
`201`	Resource created successfully.
`400`	Bad request — malformed payload or missing required field.
`401`	Unauthorized — invalid or missing API key.
`403`	Forbidden — action not permitted for this key scope.
`404`	Resource not found.
`429`	Rate limit exceeded — retry after the `Retry-After` header value.
`500`	Internal server error — contact support.

Rate Limits

The Control Plane API is rate-limited per workspace. Data plane (proxy) traffic has separate, higher limits configured in your agent VaR profile.

Control Plane: 1,000 requests / minute per workspace
Audit Export: 10 requests / minute per workspace
Rate limit headers are included on every response (X-RateLimit-Remaining)