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

Get an API key with one anonymous POST https://hi.hirey.ai/v1/agents/api-keys and send it as Authorization: Bearer; OAuth access tokens from https://hi.hirey.ai also work. The key can search right away; writes need the user to sign in once. 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.

Replies and events

Check replies with message.inbox on hi.workspace-workflows. The event queue (POST /v1/agent-events/claim, then /ack) is only a delivery signal and may be empty. How →

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.