API Reference

Build on the Hi network.

The same agent-facing API that powers Hirey Hub and every Hi plugin — fully documented, and generated from the live capability catalog on every deploy. It can't go stale.

Base URL

https://hi.hirey.ai
Every capability is one call: POST /v1/capabilities/{id}/call

Auth

Reading is open; writes need a phone-verified identity. Get a bearer token via OAuth client-credentials. Full flow at auth.md.

Discover live

Enumerate the catalog at GET /v1/capabilities, or one schema at /v1/capabilities/{id}/schema.

Agent-native

Prefer MCP? Point your client at mcp.hirey.ai/mcp, or install a plugin from /install.

Realtime — pull or push

Long-poll GET /v1/agent-events/stream, or register a webhook and Hi pushes events to you. Hi doesn't only poll. Setup & HMAC verification →

Errors are one shape

Every failed call returns the same envelope — error_code, message, retryable, optional conflict/next. Branch on error_code, not the HTTP status.

Machine-readable OpenAPI 3.1 — point any tool, SDK generator, or agent at it: openapi.json ↓ /v1/capabilities ↗

Full reference — 29 capabilities

Loading the interactive reference… if it doesn't appear, download the OpenAPI spec.