API integrations

Use API distribution when your application backend owns the conversation flow. The agent Distribute tab has an API channel for the current setup path.

Integration model

Your backend should:

• Store the workspace API key securely.
• Create or identify the User in your own system.
• Start the Hyponema session or channel flow needed by your application.
• Pass only browser-safe session values to web or mobile clients.
• Record your own application context without leaking secrets into prompts or metadata.

The same server-side API key model also supports backend automation for dashboard frontend surfaces such as agents, knowledge, integrations, tests, phone numbers, schedules, Users, conversations, memory, voice bookmarks and provider discovery, observability, webhooks, and audit review. Choose granular scopes for the surfaces your backend needs.

Text chat

For text chat, the backend starts the session and sends User messages to Hyponema. Streaming responses should be consumed using the Server-Sent Events guidance in the API tab or current backend reference. Treat the public docs as conceptual; copy exact request shapes from the dashboard or generated client used by your application.

Voice clients

For browser or app voice clients, the backend should create the session and provide a signed connection value to the client. The client should not construct privileged API calls or hold workspace credentials.

Operational checks

Before exposing an API integration to Users:

• Confirm the agent can be previewed.
• Confirm required provider credentials are present.
• Run the relevant Tests and inspect failed Runs.
• Check Observability after a staging session.
• Review Billing limits for the expected traffic.
• Keep member management, provider credential entry, billing changes, compliance exports, User erasure, recording retrieval, API key management, and WhatsApp account administration in the dashboard.