Hyphen SDK

Embed Hyphen surfaces directly into your products, partner environments, or operator-facing experiences. The SDK provides browser-safe Web Components that connect users to Hyphen's runtime through the gateway without requiring a frontend framework or direct engine tenancy in the browser.

What it does

The SDK exposes a set of embeddable surfaces:

Component	Purpose
`<hyphen-task-sidebar>`	Pending approval tasks from your workflows
`<hyphen-data-grid>`	Sortable, paginated data tables with inline editing
`<hyphen-doc-feed>`	Document upload surface that triggers workflow runs
`<hyphen-auth-modal>`	OTP-based login for per-user audit trails
`<hyphen-agent-console>`	Interactive agent execution and reasoning trace viewer

Each component renders inside Shadow DOM and authenticates through the gateway using a publishable key.

Why teams use it

Embed instead of rebuild. Ship approvals, operational tables, uploads, guided workflow surfaces, and live runtime views without rebuilding the UI layer from scratch.

Keep tenancy and scope server-side. The SDK never sends X-Org-Id directly. The gateway resolves organization context from the publishable key and session.

Support multiple delivery models. Use the SDK in operator surfaces, partner admin environments, or other browser-based product experiences.

Architecture

text

Your tool or hosted page
    |
    v
[SDK Components]  -->  [Hyphen Gateway]  -->  [Hyphen Runtime]
    ^                    |
    |                    v
[publishable key]   [session + scope + org resolution]

The SDK uses:

publishable keys for scope and origin control
gateway-backed sessions for browser-safe access
real-time events for live surface updates

Recommended entry points

If you want to...	Start here
embed task, table, or document surfaces	SDK Quickstart
understand auth and sessions	Authentication
match your host product styling	Theming
understand guided authoring in the platform	Process Studio

Delivery model