API overview

The Hyponema public API is available at:

https://api.hyponema.ai

Hyponema is currently in private beta. You need an enabled workspace and a workspace API key to use authenticated endpoints.

Authentication

Send workspace API keys as bearer tokens. Workspace keys are prefixed hyp_ and are minted from the dashboard under Settings → API keys.

Authorization: Bearer hyp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Never expose a workspace API key to a browser or mobile client. Client-side integrations should use signed session URLs or tokens created by your backend.

Request format

Use JSON request bodies:

Content-Type: application/json

Curated reference

This reference documents the supported public integration paths first:

Creating and ending sessions.
Sending text chat messages over SSE.
Connecting browser or SDK clients through signed session URLs.
Receiving outbound webhooks.

The dashboard exposes the full workspace-scoped surface for operator workflows:

Resource family	Path prefix
Agents, agent versions, publish / rollback	`/workspaces/{ws}/agents`
Personas and persona versions	`/workspaces/{ws}/personas`
Tools (HTTP + MCP) and per-agent attachments	`/workspaces/{ws}/tools`, `/workspaces/{ws}/agents/{id}/tools`
Knowledge base sources, chunks, query, attach	`/workspaces/{ws}/knowledge-base`
Voice profiles, voice assets, voice catalog	`/workspaces/{ws}/voice-profiles`, `/voice-assets`
Listening profiles and assignments	`/workspaces/{ws}/agents/{id}/listening-profiles`
Post-session runners and records	`/workspaces/{ws}/agents/{id}/post-session-runners`
Dynamic variables and resolvers	`/workspaces/{ws}/variables/catalog`, `/agents/{id}/variable-resolver`
Phone numbers and schedules	`/workspaces/{ws}/phone-numbers`, `/workspaces/{ws}/schedules`
Billing, plans, entitlements, checkout, portal	`/workspaces/{ws}/billing`
Webhooks, deliveries	`/workspaces/{ws}/webhooks`
Memory, users, profile fields, attributes	`/workspaces/{ws}/memory`, `/users`, `/profile-fields`
Members, SSO, API keys, audit log	`/workspaces/{ws}/members`, `/sso`, `/api-keys`, `/audit-log`
Evaluations, datasets, scorers, tests, runs	`/workspaces/{ws}/datasets`, `/scorers`, `/tests`, `/runs`
Observability and live sessions	`/workspaces/{ws}/observability`, `/live-sessions`

The full internal OpenAPI surface is broader than the public integration contract; not every endpoint is stable for external automation. When in doubt, prefer the dashboard for operator workflows and the documented public paths for product integrations.

Errors

Validation errors return structured JSON. Streaming endpoints may also emit an SSE error event with a detail and error_kind.