11# examples
22
3- Agent-maintained examples showing how to use Deepgram SDKs with popular platforms, frameworks, and ecosystems.
4-
5- ** All examples are built and maintained by autonomous agents.** Humans can direct, override, and add examples at any time.
3+ A collection of working examples showing how to use Deepgram SDKs with popular platforms, frameworks, and ecosystems.
64
75[ → Contributing] ( CONTRIBUTING.md ) · [ → Open PRs] ( ../../pulls ) · [ → Suggest an example] ( ../../issues/new/choose )
86
9- ## How it works
10-
11- 1 . ** PM** — Discovers new integration opportunities weekly; accepts freeform suggestions from any GitHub issue
12- 2 . ** Researcher** — Gathers platform SDK docs and credential requirements before building starts
13- 3 . ** Engineer** — Builds the full integration (src/, tests/, .env.example, README) and opens a PR
14- 4 . ** Lead — E2E** — Runs a real Deepgram API smoke test on every PR (STT + TTS)
15- 5 . ** Lead — Review** — Checks code quality and verifies the integration is genuine (real SDK calls, not mocked)
16- 6 . ** Lead — Fix** — If tests fail, investigates and repairs; retries up to 3 times before escalating
17- 7 . ** Merge** — Once E2E passes and review is approved, the PR squash-merges automatically
18-
19- PRs requiring partner credentials stay open with a ` ⏸ ` comment until secrets are configured. Every merged example has passed a real Deepgram API call.
20-
217## Examples
228
239<!-- examples-table-start -->
@@ -40,7 +26,23 @@ PRs requiring partner credentials stay open with a `⏸` comment until secrets a
4026| [ 150] ( examples/150-flutter-voice-transcription-dart/ ) | Flutter Voice Transcription | Dart | Flutter | ✅ passing |
4127<!-- examples-table-end -->
4228
43- * Status verified by manual CI run on 2026-03-30.*
29+ * Status last updated 2026-03-30.*
30+
31+ ## CI / testing
32+
33+ Every PR that touches ` examples/** ` runs language-specific test jobs automatically. The ` e2e-api-check ` status check is required before merge.
34+
35+ | Language | Marker file |
36+ | ----------| -------------|
37+ | Node.js / TypeScript | ` package.json ` |
38+ | Python | ` requirements.txt ` or ` pyproject.toml ` |
39+ | Go | ` go.mod ` |
40+ | Java | ` pom.xml ` or ` build.gradle ` |
41+ | Rust | ` Cargo.toml ` |
42+ | .NET | ` *.csproj ` or ` *.sln ` |
43+ | CLI | ` example.sh ` or ` src/*.sh ` |
44+
45+ All examples are also tested on a recurring schedule to catch regressions from SDK updates or API changes.
4446
4547## Directory structure
4648
@@ -52,46 +54,25 @@ examples/
5254 src/ # Source code
5355 tests/ # Tests — exit 0=pass, 1=fail, 2=missing credentials
5456
55- instructions/ # Agent prompts — edit these to change agent behaviour
56- pm.md # PM: discover integration opportunities
57- pm-dashboard.md # PM: rebuild README status table
58- pm-suggestions.md # PM: route any freeform issue
59- researcher.md # Researcher: gather platform context before building
60- engineer.md # Engineer: build examples
61- lead-review.md # Lead: review PRs + genuine integration check
62- lead-fix.md # Lead: fix failing tests
63-
6457tests/
6558 e2e.py # Deepgram STT + TTS smoke test (runs on every PR)
6659
6760.github/
68- workflows/ # CI and agent workflows
69- ISSUE_TEMPLATE/ # Single freeform suggestion template
70- CODEOWNERS # Protects .github/ from agent modification
61+ workflows/ # CI workflows
62+ ISSUE_TEMPLATE/ # Issue templates
7163```
7264
7365## Numbering convention
7466
7567Examples are numbered globally in increments of 10: ` 010 ` , ` 020 ` , ` 030 ` … A platform owns its group — a second Twilio example would be ` 021 ` , not a new slot. New platforms claim the next free multiple of 10.
7668
77- ## Language support
78-
79- | Language | Test workflow | Marker file |
80- | ----------| --------------| -------------|
81- | Node.js / TypeScript | ` test-node.yml ` | ` package.json ` |
82- | Python | ` test-python.yml ` | ` requirements.txt ` or ` pyproject.toml ` |
83- | Go | ` test-go.yml ` | ` go.mod ` |
84- | Java | ` test-java.yml ` | ` pom.xml ` or ` build.gradle ` |
85-
8669## Setup
8770
88- 1 . Add ` ANTHROPIC_API_KEY ` as a repository secret — required for all agent workflows
89- 2 . Add ` DEEPGRAM_API_KEY ` as a repository secret — required for E2E tests
90- 3 . Add partner credentials as needed (each example's ` .env.example ` lists them)
91- 4 . Enable ** auto-merge** in repository Settings → General → Pull Requests
71+ 1 . Add ` DEEPGRAM_API_KEY ` as a repository secret — required for E2E tests
72+ 2 . Add partner credentials as needed (each example's ` .env.example ` lists them)
9273
9374` GITHUB_TOKEN ` is provided automatically by GitHub Actions.
9475
95- ## Suggesting an example
76+ ## Contributing
9677
97- Open any GitHub issue and write whatever you like — the PM agent reads it, figures out what you mean, and routes it. No template or label required .
78+ Open an issue to suggest a new example, or submit a PR directly. See [ CONTRIBUTING.md ] ( CONTRIBUTING.md ) for guidelines .
0 commit comments