From 3173fbf10ea2e1f998b61b6472b21e61ee594b4c Mon Sep 17 00:00:00 2001 From: luke-speechify <289678208+luke-speechify@users.noreply.github.com> Date: Fri, 21 Aug 2026 00:44:20 +0100 Subject: [PATCH 1/2] feat: add agent-events-inspector demo A debug timeline for Voice Agent calls: replay a sample realtime event stream, or inspect a live conversation by id via the Voice Agents API. Hosted under /agent-events-inspector, gated with the shared Turnstile helper. The workspace key stays server-side in one route handler. --- README.md | 1 + demos/agent-events-inspector/.env.example | 1 + demos/agent-events-inspector/.gitignore | 5 + demos/agent-events-inspector/README.md | 58 ++++ .../app/api/conversation/route.ts | 53 ++++ demos/agent-events-inspector/app/globals.css | 283 ++++++++++++++++++ demos/agent-events-inspector/app/layout.tsx | 21 ++ .../app/lib/turnstile.ts | 37 +++ demos/agent-events-inspector/app/page.tsx | 268 +++++++++++++++++ .../app/sample-events.ts | 55 ++++ demos/agent-events-inspector/demo.json | 6 + demos/agent-events-inspector/next.config.ts | 11 + demos/agent-events-inspector/package.json | 25 ++ demos/agent-events-inspector/tsconfig.json | 41 +++ pnpm-lock.yaml | 25 ++ pnpm-workspace.yaml | 1 + site/public/index.html | 4 +- vercel.json | 8 + 18 files changed, 901 insertions(+), 2 deletions(-) create mode 100644 demos/agent-events-inspector/.env.example create mode 100644 demos/agent-events-inspector/.gitignore create mode 100644 demos/agent-events-inspector/README.md create mode 100644 demos/agent-events-inspector/app/api/conversation/route.ts create mode 100644 demos/agent-events-inspector/app/globals.css create mode 100644 demos/agent-events-inspector/app/layout.tsx create mode 100644 demos/agent-events-inspector/app/lib/turnstile.ts create mode 100644 demos/agent-events-inspector/app/page.tsx create mode 100644 demos/agent-events-inspector/app/sample-events.ts create mode 100644 demos/agent-events-inspector/demo.json create mode 100644 demos/agent-events-inspector/next.config.ts create mode 100644 demos/agent-events-inspector/package.json create mode 100644 demos/agent-events-inspector/tsconfig.json diff --git a/README.md b/README.md index b23a0c8..e198e4e 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ Demos with a **Live** link run in your browser at [demos.speechify.ai](https://d | [`demos/mastra-agent-speechify/`](./demos/mastra-agent-speechify) | TypeScript (Mastra) | | Text-in, speech-out Mastra Agent using an OpenAI LLM for replies and Speechify's simba-3.2 model for TTS via `@mastra/voice-speechify`. | | [`demos/voice-agent-showcase/`](./demos/voice-agent-showcase) | Cloudflare Workers | | One page, ten live Voice Agents API demos: calendar booking, policy-bound support, a page copilot, form intake, US outbound calls with a 5-minute cap, a voice gallery, mid-call language handoff, cross-call memory, a grounded knowledge base, and dual-control troubleshooting. | | [`demos/vercel-ai-sdk/`](./demos/vercel-ai-sdk) | TypeScript (Vercel AI SDK) | | Speechify TTS through the Vercel AI SDK's unified `generateSpeech` interface via the official `@speechify/vercel` provider — one-line swap from OpenAI/ElevenLabs, plus word-level speech marks from `providerMetadata`. | +| [`demos/agent-events-inspector/`](./demos/agent-events-inspector) | Next.js | [Open](https://demos.speechify.ai/agent-events-inspector) | A debug timeline for Voice Agent calls: replay a sample realtime event stream, or inspect a live conversation by id. The workspace key stays server-side. | ## Get an API key diff --git a/demos/agent-events-inspector/.env.example b/demos/agent-events-inspector/.env.example new file mode 100644 index 0000000..534cec4 --- /dev/null +++ b/demos/agent-events-inspector/.env.example @@ -0,0 +1 @@ +SPEECHIFY_API_KEY=your_api_key_here diff --git a/demos/agent-events-inspector/.gitignore b/demos/agent-events-inspector/.gitignore new file mode 100644 index 0000000..95d1bcb --- /dev/null +++ b/demos/agent-events-inspector/.gitignore @@ -0,0 +1,5 @@ +node_modules/ +.next/ +.env +next-env.d.ts +*.tsbuildinfo diff --git a/demos/agent-events-inspector/README.md b/demos/agent-events-inspector/README.md new file mode 100644 index 0000000..c67d1dc --- /dev/null +++ b/demos/agent-events-inspector/README.md @@ -0,0 +1,58 @@ +# Voice agent events inspector + +A tiny debug view for a Speechify Voice Agent call. Watch a call unfold as a +timeline of realtime events — session start, user transcripts, agent replies, +tool calls and results, session end — either by **replaying a bundled sample +stream** or by **inspecting one of your own conversations by id**. The workspace +API key stays server-side. + +Pairs with the Speechify post *Realtime agent events: debugging a live voice +agent call*. + +## What you get + +- A **timeline** that colour-codes events by source (session / user / agent / + tool) and lets you expand any event's raw JSON payload. +- **Replay mode** — plays the sample event stream in + [`app/sample-events.ts`](./app/sample-events.ts) against a scrubber, at + 0.5×–4× speed, so you can see how a call reads as a stream. +- **Inspect mode** — enter a `conv_…` id (or leave blank to list recent calls); + the server proxies `GET /v1/agents/conversations/{id}` on the Voice Agents API + and renders what comes back. +- **[`app/api/conversation/route.ts`](./app/api/conversation/route.ts)** — the + one server route that holds the key and talks to the API. + +## Run it yourself + +```bash +cp .env.example .env # paste your Speechify workspace API key +pnpm install +pnpm dev # http://localhost:8774/agent-events-inspector +``` + +Get a workspace key at [platform.speechify.ai/api-keys](https://platform.speechify.ai/api-keys). +Replay mode needs no key; inspect mode needs a key with a Voice Agents workspace. + +## On the event schema + +The confirmed conversation record fields are `id`, `agent_id`, `status`, +`started_at`, `ended_at`, and `duration_ms` — the same ones the +[voice-agent-showcase](../voice-agent-showcase) reads. The per-event stream shape +in `app/sample-events.ts` is **illustrative**: it shows how you'd render a live +event feed, and the inspector renders whichever event/transcript array a live +conversation returns. Confirm the exact live event field names against the +[Voice Agents API docs](https://docs.speechify.ai) before wiring this to a +production audit tool. + +## Abuse protection (hosted) + +The hosted build gates `/api/conversation` with Cloudflare Turnstile via the +shared [`app/lib/turnstile.ts`](./app/lib/turnstile.ts) helper. It fail-opens +when `TURNSTILE_SECRET_KEY` is unset, so local dev and forks work with zero +config. + +## Prerequisites + +- Node 20+. +- For inspect mode: a Speechify workspace with the Voice Agents API and at least + one conversation to look at. diff --git a/demos/agent-events-inspector/app/api/conversation/route.ts b/demos/agent-events-inspector/app/api/conversation/route.ts new file mode 100644 index 0000000..9e6d1dc --- /dev/null +++ b/demos/agent-events-inspector/app/api/conversation/route.ts @@ -0,0 +1,53 @@ +import { NextResponse } from "next/server"; +import { verifyTurnstile } from "../../lib/turnstile"; + +export const runtime = "nodejs"; + +const BASE = "https://api.speechify.ai"; + +// Proxies the Voice Agents conversations API so the workspace key never reaches +// the browser. A single id returns that conversation; no id lists recent ones. +export async function POST(req: Request) { + if (!(await verifyTurnstile(req))) { + return NextResponse.json({ error: "Forbidden" }, { status: 403 }); + } + + const key = process.env.SPEECHIFY_API_KEY; + if (!key) { + return NextResponse.json( + { error: "SPEECHIFY_API_KEY is not set on the server." }, + { status: 503 }, + ); + } + + const { id } = (await req.json().catch(() => ({}))) as { id?: string }; + + // conv_ ids only — don't proxy arbitrary paths. + if (id && !/^conv_[a-z0-9]+$/i.test(id)) { + return NextResponse.json({ error: "That doesn't look like a conversation id (conv_…)." }, { status: 400 }); + } + + const path = id ? `/v1/agents/conversations/${id}` : `/v1/agents/conversations?limit=20`; + + try { + const upstream = await fetch(`${BASE}${path}`, { + headers: { Authorization: `Bearer ${key}` }, + }); + const text = await upstream.text(); + let data: unknown = null; + try { + data = text ? JSON.parse(text) : null; + } catch { + /* non-JSON upstream error */ + } + if (!upstream.ok) { + return NextResponse.json( + { error: `Upstream ${upstream.status}`, detail: data ?? text.slice(0, 300) }, + { status: upstream.status }, + ); + } + return NextResponse.json(data); + } catch (err) { + return NextResponse.json({ error: (err as Error).message }, { status: 502 }); + } +} diff --git a/demos/agent-events-inspector/app/globals.css b/demos/agent-events-inspector/app/globals.css new file mode 100644 index 0000000..37ef027 --- /dev/null +++ b/demos/agent-events-inspector/app/globals.css @@ -0,0 +1,283 @@ +:root { + color-scheme: light dark; + --fg: #111; + --bg: #fff; + --muted: #666; + --border: #ddd; + --surface: #f6f6f6; + --session: #6b7280; + --user: #2563eb; + --agent: #059669; + --tool: #d97706; + --other: #9333ea; +} + +@media (prefers-color-scheme: dark) { + :root { + --fg: #f2f2f2; + --bg: #0c0c0c; + --muted: #999; + --border: #2a2a2a; + --surface: #161616; + --session: #9ca3af; + --user: #60a5fa; + --agent: #34d399; + --tool: #fbbf24; + --other: #c084fc; + } +} + +* { + box-sizing: border-box; +} + +body { + margin: 0; + padding: 2rem 1rem; + background: var(--bg); + color: var(--fg); + font-family: ui-sans-serif, system-ui, -apple-system, sans-serif; + line-height: 1.5; +} + +main { + max-width: 46rem; + margin: 0 auto; + display: flex; + flex-direction: column; + gap: 1.25rem; +} + +h1 { + font-size: 1.6rem; + font-weight: 500; + margin: 0 0 0.4rem; +} + +.lead { + color: var(--muted); + margin: 0; +} + +code, +.json { + font-family: ui-monospace, SFMono-Regular, Menlo, monospace; +} + +code { + background: var(--surface); + padding: 0.1em 0.4em; + border-radius: 4px; + font-size: 0.85em; +} + +.tabs { + display: flex; + gap: 0.5rem; +} + +.tabs button { + font: inherit; + cursor: pointer; + padding: 0.5rem 1rem; + border-radius: 999px; + border: 1px solid var(--border); + background: var(--bg); + color: var(--fg); +} + +.tabs button.on { + background: var(--fg); + color: var(--bg); + border-color: var(--fg); +} + +.panel { + border: 1px solid var(--border); + border-radius: 0.6rem; + padding: 1rem; + background: var(--surface); +} + +.meta { + display: flex; + align-items: center; + gap: 0.6rem; + flex-wrap: wrap; + margin-bottom: 0.75rem; + font-size: 0.85rem; + color: var(--muted); +} + +.pill { + border: 1px solid var(--border); + border-radius: 999px; + padding: 0.05rem 0.6rem; + font-size: 0.75rem; + text-transform: uppercase; + letter-spacing: 0.06em; +} + +.controls { + display: flex; + align-items: center; + gap: 0.75rem; + margin-bottom: 0.75rem; + flex-wrap: wrap; +} + +.controls button, +.live-input button { + font: inherit; + cursor: pointer; + padding: 0.4rem 1rem; + border-radius: 6px; + border: none; + background: var(--fg); + color: var(--bg); +} + +.controls input[type="range"] { + flex: 1; + min-width: 8rem; +} + +.controls label { + display: flex; + align-items: center; + gap: 0.35rem; + font-size: 0.85rem; + color: var(--muted); +} + +.controls select, +.live-input input { + font: inherit; + color: var(--fg); + background: var(--bg); + border: 1px solid var(--border); + border-radius: 6px; + padding: 0.35rem 0.5rem; +} + +.live-input { + display: flex; + gap: 0.5rem; + margin-bottom: 0.5rem; +} + +.live-input input { + flex: 1; +} + +.timeline { + list-style: none; + margin: 0; + padding: 0; + display: flex; + flex-direction: column; + gap: 0.25rem; +} + +.evt { + display: grid; + grid-template-columns: 5.5rem 11rem 1fr auto; + gap: 0.5rem; + align-items: baseline; + padding: 0.35rem 0.5rem; + border-left: 3px solid var(--border); + border-radius: 0 5px 5px 0; + background: var(--bg); + font-size: 0.85rem; +} + +.evt.active { + outline: 2px solid var(--agent); +} + +.evt.session { border-left-color: var(--session); } +.evt.user { border-left-color: var(--user); } +.evt.agent { border-left-color: var(--agent); } +.evt.tool { border-left-color: var(--tool); } +.evt.other { border-left-color: var(--other); } + +.evt .t { + color: var(--muted); + font-family: ui-monospace, SFMono-Regular, Menlo, monospace; + font-size: 0.78rem; +} + +.evt .type { + font-family: ui-monospace, SFMono-Regular, Menlo, monospace; + font-size: 0.8rem; +} + +.evt.session .type { color: var(--session); } +.evt.user .type { color: var(--user); } +.evt.agent .type { color: var(--agent); } +.evt.tool .type { color: var(--tool); } +.evt.other .type { color: var(--other); } + +.evt .summary { + color: var(--muted); + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.evt .peek { + font: inherit; + font-size: 0.75rem; + cursor: pointer; + border: 1px solid var(--border); + border-radius: 5px; + background: var(--surface); + color: var(--fg); + padding: 0 0.4rem; +} + +.json { + grid-column: 1 / -1; + margin: 0.4rem 0 0; + padding: 0.6rem; + background: var(--surface); + border: 1px solid var(--border); + border-radius: 6px; + font-size: 0.78rem; + overflow-x: auto; +} + +.json.raw { + max-height: 30rem; + overflow: auto; +} + +.error { + color: #dc2626; + font-size: 0.9rem; +} + +.hint { + color: var(--muted); + font-size: 0.9rem; +} + +@media (max-width: 640px) { + .evt { + grid-template-columns: 4.5rem 1fr auto; + } + .evt .summary { + grid-column: 1 / -1; + } +} + +footer { + color: var(--muted); + font-size: 0.85rem; + border-top: 1px solid var(--border); + padding-top: 1rem; +} + +footer a { + color: inherit; +} diff --git a/demos/agent-events-inspector/app/layout.tsx b/demos/agent-events-inspector/app/layout.tsx new file mode 100644 index 0000000..4c8fea7 --- /dev/null +++ b/demos/agent-events-inspector/app/layout.tsx @@ -0,0 +1,21 @@ +import type { Metadata } from "next"; +import type { ReactNode } from "react"; +import Script from "next/script"; +import "./globals.css"; + +export const metadata: Metadata = { + title: "Voice agent events inspector", + description: + "Replay a sample realtime event stream or inspect a live Speechify Voice Agent conversation in a debug timeline.", +}; + +export default function RootLayout({ children }: { children: ReactNode }) { + return ( + + + + @@ -368,7 +368,7 @@

FAQ