[Example] 510 — Gin (Go) Real-Time WebSocket Transcription Server by github-actions[bot] · Pull Request #197 · deepgram/examples

github-actions · 2026-04-06T09:01:19Z

New example: Gin (Go) Real-Time WebSocket Transcription Server

Integration: Gin | Language: Go | Products: STT

What this shows

A Go web server using Gin and the Deepgram Go SDK that accepts WebSocket audio from a browser, relays it to Deepgram's Live STT API (Nova-3), and streams transcription results back in real time. Includes a minimal HTML/JS client page served by the Gin server for testing.

Required secrets

None — only DEEPGRAM_API_KEY required

Tests

✅ Tests passed

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.34s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.351s

Closes #188

Built by Engineer on 2026-04-06

…r (Go) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

github-actions · 2026-04-06T12:39:30Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.61s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.615s

Integration genuineness

Pass — All 6 checks pass:

Gin SDK imported and used for HTTP server + WebSocket upgrade
Real Deepgram API call via listen.NewWSUsingCallback through the Gin server
.env.example lists DEEPGRAM_API_KEY (Gin is a framework, no API key needed)
Test exits 2 on missing credentials, makes real API call
Audio flows through Gin WebSocket handler → Deepgram SDK (no bypass)
No raw WebSocket/fetch calls to Deepgram — SDK used throughout

Code quality

Official Deepgram Go SDK v3.5.0 (current required version) ✅
Tag: []string{"deepgram-examples"} present ✅
No hardcoded credentials — API key from os.Getenv ✅
Error handling: WS upgrade failure, missing API key, Deepgram connect failure, write errors ✅
Tests import from src/server and call actual server code via httptest.NewServer ✅
WebSocket pipeline test makes real HTTP/WS requests to the running server ✅
Transcript assertions use count-based checks, not word lists (non-deterministic safe) ✅
Credential check (requiredEnv) runs before any SDK usage ✅
Mutex protects concurrent writes to browser WebSocket from Deepgram callbacks ✅

Documentation

README includes "What you'll build", prerequisites, env var table with console links, install/run instructions, key parameters, and architecture walkthrough ✅
.env.example present and complete ✅

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-06

github-actions · 2026-04-06T16:36:59Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.32s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.326s

Integration genuineness

✅ Pass — All 6 checks pass.

Gin framework imported and used to serve routes and upgrade WebSocket connections
Deepgram Go SDK v3.5.0 (listen.NewWSUsingCallback) makes real API calls — confirmed by "Deepgram connection opened" callback firing in test
.env.example lists DEEPGRAM_API_KEY (only credential needed for a Gin + Deepgram integration)
requiredEnv() exits with code 2 if credentials are missing — runs before any SDK calls
No bypass: Gin is a web framework without a Deepgram interface; audio correctly flows browser → Gin WS → Deepgram SDK
No raw protocol usage: all Deepgram contact goes through the official SDK

Code quality

✅ All checks pass:

Official Deepgram SDK used (deepgram-go-sdk/v3 v3.5.0 — matches required version)
tag: []string{"deepgram-examples"} present in LiveTranscriptionOptions
No hardcoded credentials — API key read from os.Getenv
Error handling covers: WS upgrade failure, missing API key, Deepgram client creation failure, connection failure, write errors, and Deepgram error callback
Tests import from src/server and call the example's actual code via server.NewServer()
Server test spins up httptest.NewServer, dials a real WebSocket, sends audio, and reads responses
Transcript assertions are proportional (accepts 0 transcripts for synthetic audio — no word-list assertions)
Credential check (requiredEnv) runs first before SDK usage

Documentation

✅ README includes:

"What you'll build" section
All env vars with where-to-get links (Deepgram console)
Install and run instructions
Key parameters table
How it works explanation
.env.example present and complete

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-06

github-actions · 2026-04-06T20:33:52Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.34s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.351s

Integration genuineness

✅ Pass — All 6 checks pass:

Gin SDK imported and used (gin.Default(), route registration, WS upgrade)
Real Deepgram API call via listen.NewWSUsingCallback with live credentials
.env.example lists DEEPGRAM_API_KEY (Gin itself requires no credentials)
Credential check runs first with os.Exit(2) on missing vars
Bypass check N/A — Gin is a web framework, not an audio interface; Deepgram SDK used correctly for STT
No raw WebSocket/fetch to Deepgram — gorilla/websocket only used for browser↔server; SDK handles all Deepgram communication

Code quality

✅ Official Deepgram Go SDK v3.5.0 (matches required version)
✅ tag: "deepgram-examples" present in LiveTranscriptionOptions
✅ No hardcoded credentials — API key read from os.Getenv
✅ Error handling covers: WS upgrade failure, missing API key, Deepgram connection failure, audio write errors
✅ Tests import from src/server and exercise actual server endpoints
✅ Server test spins up httptest.NewServer, dials WebSocket, sends 2s of PCM audio
✅ No word-list assertions — transcript count check accepts 0 for synthetic audio
✅ Mutex-protected WebSocket writes in DeepgramCallback (thread-safe)

Documentation

✅ README includes "What you'll build", env var table with console link, install/run instructions, key parameters, architecture walkthrough
✅ .env.example present and complete

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-06

github-actions · 2026-04-07T01:03:51Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.28s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.284s

Integration genuineness

Pass — Gin framework is correctly used as the HTTP/WebSocket server layer. All Deepgram API contact goes through the official Go SDK (listen.NewWSUsingCallback, dgClient.Write). No raw WebSocket or HTTP calls to Deepgram. Gin does not provide a Deepgram audio interface, so direct SDK usage is appropriate here.

Code quality

Official Deepgram Go SDK v3.5.0 (matches required version) ✅
tag: ["deepgram-examples"] present in LiveTranscriptionOptions ✅
No hardcoded credentials — API key read from DEEPGRAM_API_KEY env var ✅
Error handling covers: WS upgrade failure, missing API key, Deepgram client creation, connection failure, audio write errors ✅
Tests import from src/server and call the example's actual code via server.NewServer() ✅
Test spins up httptest.NewServer and makes real WebSocket connections ✅
No word-list transcript assertions — uses count-based check (0 expected for synthetic audio) ✅
Credential check (requiredEnv) runs first with os.Exit(2) on missing credentials ✅

Documentation

README includes "What you'll build", env var table with Deepgram console link, install/run instructions ✅
.env.example present and complete ✅
Key parameters table explains all Deepgram STT options ✅

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-07

github-actions · 2026-04-07T05:04:53Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.34s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.351s

Integration genuineness

Pass — Gin framework is imported and used for HTTP routing and WebSocket upgrades. Deepgram SDK (deepgram-go-sdk/v3 v3.5.0) handles all Deepgram API communication via listen.NewWSUsingCallback. No raw WebSocket or HTTP calls to Deepgram. Browser WebSocket connects to the Gin server, not Deepgram directly.

Code quality

✅ Official Deepgram Go SDK v3.5.0 (current required version)
✅ Tag: []string{"deepgram-examples"} present in LiveTranscriptionOptions
✅ No hardcoded credentials — API key from os.Getenv
✅ Error handling covers: WS upgrade failure, missing API key, Deepgram connection failure, audio write errors
✅ Tests import from src/server and test the actual Gin server (not standalone Deepgram client)
✅ Test spins up httptest.NewServer, makes real WebSocket connection, sends 2s of PCM audio
✅ No word-list assertions — accepts 0 transcripts for synthetic audio (proportional check)
✅ Credential check (requiredEnv) runs first with os.Exit(2) on missing vars
✅ Mutex protects concurrent WebSocket writes in callback

Documentation

✅ README has "What you'll build", env vars table with console link, install/run instructions, key parameters, architecture explanation
✅ .env.example present and complete

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-07

github-actions · 2026-04-07T12:43:10Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.33s)
PASS
ok   github.com/deepgram/examples/510-gin-live-transcription-go/tests  3.342s

Integration genuineness

✅ Pass — All 6 checks pass:

Gin SDK imported and used for HTTP server + WebSocket upgrade
Real Gin routes serve the HTML client and handle WebSocket connections
.env.example lists DEEPGRAM_API_KEY (Gin is a web framework, no platform creds needed)
Tests exit 2 on missing credentials via requiredEnv() — no fake passes
Bypass check N/A — Gin is a web framework, not an audio interface; Deepgram SDK used directly is correct
No raw WebSocket/fetch to Deepgram — all audio goes through deepgram-go-sdk/v3 via listen.NewWSUsingCallback

Code quality

✅ Official Deepgram Go SDK v3.5.0 (matches required version)
✅ Tag: []string{"deepgram-examples"} present in transcription options
✅ No hardcoded credentials — os.Getenv("DEEPGRAM_API_KEY")
✅ Error handling covers: WS upgrade failure, missing API key, Deepgram client creation, connection failure, write errors
✅ Tests import from src/server and call the example's actual NewServer()
✅ Test spins up httptest.NewServer, dials WebSocket, sends real audio, verifies Deepgram connection callback
✅ No word-list assertions — accepts 0 transcripts for synthetic audio (non-deterministic safe)
✅ Credential check (requiredEnv) runs first before any Deepgram SDK usage

Documentation

✅ README has "What you'll build", prerequisites, env var table with console link, run instructions, key parameters, and architecture walkthrough
✅ .env.example present and complete

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-07

github-actions · 2026-04-07T16:41:35Z

Code Review

Overall: APPROVED

Tests ran ✅

=== RUN   TestIndexPage
--- PASS: TestIndexPage (0.00s)
=== RUN   TestWebSocketPipeline
    main_test.go:102: Deepgram connection established via server
    main_test.go:130: Successfully sent 2.0s of audio (64000 bytes) through the pipeline
    main_test.go:152: Received 0 transcript messages (0 is expected for synthetic audio)
--- PASS: TestWebSocketPipeline (3.43s)
PASS
ok  	github.com/deepgram/examples/510-gin-live-transcription-go/tests	3.441s

Integration genuineness

Pass — Gin framework (gin-gonic/gin) is imported and used to create the HTTP server and WebSocket endpoint. Deepgram Go SDK v3.5.0 (listen.NewWSUsingCallback) handles all Deepgram API communication — no raw WebSocket or HTTP calls to Deepgram. Gin is a web framework (not a speech interface), so using the Deepgram SDK directly is correct. Credential check exits with code 2 before any SDK calls.

Code quality

✅ Official Deepgram Go SDK v3.5.0 (matches required version)
✅ Tag: []string{"deepgram-examples"} present in LiveTranscriptionOptions
✅ No hardcoded credentials — API key read from os.Getenv
✅ Error handling covers WebSocket upgrade, missing API key, Deepgram connection failure, and write errors
✅ Tests import from src/server and spin up a real httptest.NewServer with real WebSocket connections
✅ No word-list assertions — test verifies pipeline connectivity and transcript count only
✅ Credential check (requiredEnv) runs first in TestWebSocketPipeline before any SDK usage
✅ Thread-safe callback via sync.Mutex on browser WebSocket writes

Documentation

✅ README includes "What you'll build", env vars with console links, run instructions, key parameters, and architecture walkthrough
✅ .env.example present and complete

✓ All checks pass. Ready for merge.

Review by Lead on 2026-04-07

github-actions bot added type:example New example language:go Language: Go integration:gin Integration: Gin labels Apr 6, 2026

github-actions bot mentioned this pull request Apr 6, 2026

[Suggestion] Gin (Go) real-time WebSocket transcription server #188

Closed

5 tasks

feat(examples): add 510 — Gin real-time WebSocket transcription serve…

8d217e0

…r (Go) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

github-actions bot force-pushed the example/510-gin-live-transcription-go branch from 52e9814 to 8d217e0 Compare April 6, 2026 09:07

github-actions bot added the status:review-passed Self-review passed label Apr 6, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Example] 510 — Gin (Go) Real-Time WebSocket Transcription Server#197

[Example] 510 — Gin (Go) Real-Time WebSocket Transcription Server#197
github-actions[bot] wants to merge 1 commit intomainfrom
example/510-gin-live-transcription-go

github-actions bot commented Apr 6, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Apr 6, 2026

Uh oh!

github-actions bot commented Apr 6, 2026

Uh oh!

github-actions bot commented Apr 6, 2026

Uh oh!

github-actions bot commented Apr 7, 2026

Uh oh!

github-actions bot commented Apr 7, 2026

Uh oh!

github-actions bot commented Apr 7, 2026

Uh oh!

github-actions bot commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

Conversation

github-actions bot commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New example: Gin (Go) Real-Time WebSocket Transcription Server

What this shows

Required secrets

Tests

Uh oh!

github-actions bot commented Apr 6, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

github-actions bot commented Apr 6, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

github-actions bot commented Apr 6, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

github-actions bot commented Apr 7, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

github-actions bot commented Apr 7, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

github-actions bot commented Apr 7, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

github-actions bot commented Apr 7, 2026

Code Review

Tests ran ✅

Integration genuineness

Code quality

Documentation

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

github-actions bot commented Apr 6, 2026 •

edited

Loading