Docs · API Reference v1
HaaS API Reference
Integration surface for programmable human outcomes. Authenticate with workspace secret keys, send track events, route execution, confirm destinations, verify outcomes, and settle HYPEIT. Financial settlement occurs after verification — not on ingest.
| Method | Path | Auth | Purpose |
|---|---|---|---|
| POST | /events/track | Bearer | Ingest track event · begin routing · settle after verification |
Introduction
This API lets Developers send track events when a human outcome should be requested. BTheHype authenticates, routes execution, and settles HYPEIT after outcome verification. All endpoints use server-to-server HTTPS.
Base URL
https://api.bthehype.com/v1Requests use HTTPS only. Responses are JSON. Timestamps are ISO-8601 UTC. Settlement is denominated in HYPEIT (peg: 100 HYPEIT = $1.00 USD) and occurs after verification — not on ingest.
Authentication
Authenticate your API requests using your Workspace Secret Key. Include this key in the header of all requests.
Authorization: Bearer haas_live_xxxxxxxxxxxxxxxxx- •Keys are issued per workspace from the Developer Console after admission and API key setup.
- •Rotate compromised keys immediately. Live keys begin with
haas_live_. - •Never embed secret keys in client-side bundles or public repositories.
Webhooks
Developers send track events from their origin servers when a desired human outcome should be requested. The protocol validates the payload, routes eligible Operators within regional node capacity, and settles HYPEIT after destination confirmation.
/events/trackSend this request when your product detects that a human outcome should be produced (for example, user activation or upgrade). Include an Idempotency-Key header. A 200 OK accepts the event and begins routing — settlement follows verification.
Request body
{
"event_type": "user_activated",
"verification_id": "usr_987654321",
"timestamp": "2026-08-27T14:30:00Z"
}| Field | Type | Description |
|---|---|---|
| event_type | string | Canonical event name from your Growth Program |
| verification_id | string | Partner-side user or session identifier |
| timestamp | string | ISO-8601 UTC event time |
| idempotency_key | header | Required via Idempotency-Key header — duplicate keys return the original response |
200 Response
{
"status": "accepted",
"request_id": "req_abc123",
"message": "Event accepted — routing begins. Settlement occurs after outcome verification."
}Error Codes
The API uses standard HTTP status codes. Error bodies include a machine-readable error.code and a human-readable message.
Event accepted. Routing begins. HYPEIT settlement occurs after destination confirmation verifies the outcome.
Invalid or missing workspace secret key. Confirm the Authorization Bearer token matches a live key issued to your workspace.
Insufficient program funding. Re-fund your Growth Program before requesting additional outcomes.
Rate limit exceeded. Back off and retry according to the Retry-After header.
Program funding
Developers fund Growth Programs with HYPEIT via an approved payment provider. BTheHype's internal ledger settles in HYPEIT (100 HYPEIT = $1 USD). HYPEIT is consumed when verified outcomes settle — not when track events are accepted.
HYPEIT →