Groq Reference Architecture
Overview
Production architecture for applications built on Groq's LPU inference API. It
covers four concerns that every serious Groq integration needs: routing requests
to the right model by latency/capability/cost, a middleware band (cache, metrics,
retry), a multi-provider fallback chain, and a streaming pipeline. The service
layer built here is reusable across a chat UI, an API backend, a batch processor,
or an agent.
The full layer diagram and how the pieces interact lives in
references/architecture.md; the complete,
copy-ready TypeScript for every layer is in
references/implementation.md.
Prerequisites
- Groq API key — create one at console.groq.com
and export it as
GROQ_API_KEY. The Groq SDK reads it from the environment;
the client is constructed as new Groq({ apiKey: process.env.GROQ_API_KEY }).
Never hardcode the key.
- Runtime: Node.js 18+ (for
performance.now() and native fetch).
- Packages:
groq-sdk and lru-cache (npm install groq-sdk lru-cache).
- Optional backup provider: an OpenAI-compatible key if you extend the
fallback chain beyond Groq's own models.
Instructions
Build the service layer in five ordered steps. Each step is one file under
src/groq/. The router depends on the registry; the middleware and fallback
depend on the client; the streaming pipeline stands alone. Full source for every
step (verbatim) is in references/implementation.md.
Model Registry (models.ts) — declare a ModelSpec for each model with
its tier, context window, speed, cost, and capabilities. Skeleton:
export const MODELS: Record<string, ModelSpec> = {
"llama-3.1-8b-instant": { tier: "speed", /* fast, cheap */ },
"llama-3.3-70b-versatile": { tier: "quality", /* tools + JSON */ },
"meta-llama/llama-4-scout-17b-16e-instruct": { tier: "vision" },
"whisper-large-v3-turbo": { tier: "audio" },
};
Model Router (router.ts) — selectModel(req) maps requirements
(maxLatencyMs, needsVision, needsTools, costSensitive) to the cheapest
model that satisfies them. Callers pass requirements, never hardcoded ids.
Middleware (middleware.ts) — completionWithMiddleware() wraps each call
with an LRU cache (deterministic requests only, temperature === 0), latency +
token metrics, and a pluggable metrics sink.
Fallback Chain (fallback.ts) — completionWithFallback() tries the
primary model, drops to a model in a different rate-limit pool on 429/5xx, then
returns a graceful-degradation payload instead of throwing.
Streaming Pipeline (streaming.ts) — streamCompletion() is an async
generator yielding { type: "token" | "done" | "error" } for real-time SSE UIs.
When applying this to an existing repo, Read the current src/ layout and
Grep for direct groq.chat.completions.create calls to find code that should
route through the middleware and fallback wrappers instead.
Integration Patterns
| Pattern |
When to Use |
Groq Feature |
| Direct completion |
Simple request/response |
chat.completions.create |
| Streaming SSE |
Real-time chat UI |
stream: true |
| Tool calling |
Agent with function execution |
tools parameter |
| JSON extraction |
Structured data from text |
response_format: json_object |
| Batch processing |
High-volume document processing |
Queue + rate limiting |
| Audio transcription |
Voice input |
audio.transcriptions.create |
| Vision analysis |
Image understanding |
Llama 4 Scout/Maverick |
Output
Applying this skill produces a src/groq/ service layer with six files
(client.ts, models.ts, router.ts, middleware.ts, fallback.ts,
streaming.ts) plus the service and API layers that consume it. At runtime you get:
- Routed completions —
selectModel() returns a ModelSpec; callers never
hardcode a model id, so cost/latency policy lives in one place.
- Cached deterministic responses — repeated
temperature: 0 calls return from
the LRU cache instead of re-billing the API.
- Resilient calls —
completionWithFallback() returns a valid completion shape
even when Groq is rate-limited, never surfacing a raw 429 to the user.
- Streamed tokens —
streamCompletion() yields { type, content } events for
SSE, with a terminal done or error event.
- Metrics — every call emits
{ model, latencyMs, tokens, cached } to your
metrics sink (Prometheus, Datadog, or console.log by default).
Error Handling
| Issue |
Cause |
Solution |
| 429 on primary model |
RPM/TPM exceeded |
Fall back to different model |
| High latency |
Wrong model tier |
Route to 8b-instant for latency-critical paths |
| Context overflow |
Input > 128K tokens |
Truncate or chunk input |
| Vision errors |
Wrong model for images |
Use Llama 4 Scout full model path |
GROQ_API_KEY undefined |
Env var not exported |
Export the key before starting the process |
Examples
A latency-critical chat turn routes to the speed tier and returns one completion:
const model = selectModel({ maxLatencyMs: 80, costSensitive: true });
// → llama-3.1-8b-instant
const res = await completionWithMiddleware(groq, model.id, messages);
Streaming a UI consumes the async generator token-by-token:
for await (const event of streamCompletion(groq, messages)) {
if (event.type === "token") process.stdout.write(event.content!);
}
Four fully worked examples — latency-critical, quality-with-fallback, streaming,
and vision routing — are in references/examples.md.
Resources
Next Steps
For multi-environment deployment, see the groq-multi-env-setup skill, which
extends this service layer with per-environment configuration and secrets handling.
Source: jeremylongshore/claude-code-plugins-plus-skills → plugins/saas-packs/groq-pack/skills/groq-reference-architecture/SKILL.md
1---2name: groq-reference-architecture3description: "'Implement Groq reference architecture with model routing, streaming pipelines, and fallbacks. Use when designing new Groq integrations, reviewing project structure, or establishing architecture standards for Groq applications. Trigger with phrases like \"groq architecture\", \"groq best practices\", \"groq project structure\", \"how to organize groq\", \"groq design\". '"4allowed-tools: "Read, Grep"5category: engineering-core6source_repo: jeremylongshore/claude-code-plugins-plus-skills7source_path: "plugins/saas-packs/groq-pack/skills/groq-reference-architecture/SKILL.md"8source_url: https://github.com/jeremylongshore/claude-code-plugins-plus-skills/blob/HEAD/plugins/saas-packs/groq-pack/skills/groq-reference-architecture/SKILL.md9---1011# Groq Reference Architecture1213## Overview1415Production architecture for applications built on Groq's LPU inference API. It16covers four concerns that every serious Groq integration needs: routing requests17to the right model by latency/capability/cost, a middleware band (cache, metrics,18retry), a multi-provider fallback chain, and a streaming pipeline. The service19layer built here is reusable across a chat UI, an API backend, a batch processor,20or an agent.2122The full layer diagram and how the pieces interact lives in23[references/architecture.md](references/architecture.md); the complete,24copy-ready TypeScript for every layer is in25[references/implementation.md](references/implementation.md).2627## Prerequisites2829- **Groq API key** — create one at [console.groq.com](https://console.groq.com)30 and export it as `GROQ_API_KEY`. The Groq SDK reads it from the environment;31 the client is constructed as `new Groq({ apiKey: process.env.GROQ_API_KEY })`.32 Never hardcode the key.33- **Runtime**: Node.js 18+ (for `performance.now()` and native `fetch`).34- **Packages**: `groq-sdk` and `lru-cache` (`npm install groq-sdk lru-cache`).35- **Optional backup provider**: an OpenAI-compatible key if you extend the36 fallback chain beyond Groq's own models.3738## Instructions3940Build the service layer in five ordered steps. Each step is one file under41`src/groq/`. The router depends on the registry; the middleware and fallback42depend on the client; the streaming pipeline stands alone. Full source for every43step (verbatim) is in [references/implementation.md](references/implementation.md).44451. **Model Registry** (`models.ts`) — declare a `ModelSpec` for each model with46 its tier, context window, speed, cost, and capabilities. Skeleton:4748 ```typescript49 export const MODELS: Record<string, ModelSpec> = {50 "llama-3.1-8b-instant": { tier: "speed", /* fast, cheap */ },51 "llama-3.3-70b-versatile": { tier: "quality", /* tools + JSON */ },52 "meta-llama/llama-4-scout-17b-16e-instruct": { tier: "vision" },53 "whisper-large-v3-turbo": { tier: "audio" },54 };55 ```56572. **Model Router** (`router.ts`) — `selectModel(req)` maps requirements58 (`maxLatencyMs`, `needsVision`, `needsTools`, `costSensitive`) to the cheapest59 model that satisfies them. Callers pass requirements, never hardcoded ids.603. **Middleware** (`middleware.ts`) — `completionWithMiddleware()` wraps each call61 with an LRU cache (deterministic requests only, `temperature === 0`), latency +62 token metrics, and a pluggable metrics sink.634. **Fallback Chain** (`fallback.ts`) — `completionWithFallback()` tries the64 primary model, drops to a model in a different rate-limit pool on 429/5xx, then65 returns a graceful-degradation payload instead of throwing.665. **Streaming Pipeline** (`streaming.ts`) — `streamCompletion()` is an async67 generator yielding `{ type: "token" | "done" | "error" }` for real-time SSE UIs.6869When applying this to an existing repo, `Read` the current `src/` layout and70`Grep` for direct `groq.chat.completions.create` calls to find code that should71route through the middleware and fallback wrappers instead.7273## Integration Patterns7475| Pattern | When to Use | Groq Feature |76|---------|-------------|-------------|77| Direct completion | Simple request/response | `chat.completions.create` |78| Streaming SSE | Real-time chat UI | `stream: true` |79| Tool calling | Agent with function execution | `tools` parameter |80| JSON extraction | Structured data from text | `response_format: json_object` |81| Batch processing | High-volume document processing | Queue + rate limiting |82| Audio transcription | Voice input | `audio.transcriptions.create` |83| Vision analysis | Image understanding | Llama 4 Scout/Maverick |8485## Output8687Applying this skill produces a `src/groq/` service layer with six files88(`client.ts`, `models.ts`, `router.ts`, `middleware.ts`, `fallback.ts`,89`streaming.ts`) plus the service and API layers that consume it. At runtime you get:9091- **Routed completions** — `selectModel()` returns a `ModelSpec`; callers never92 hardcode a model id, so cost/latency policy lives in one place.93- **Cached deterministic responses** — repeated `temperature: 0` calls return from94 the LRU cache instead of re-billing the API.95- **Resilient calls** — `completionWithFallback()` returns a valid completion shape96 even when Groq is rate-limited, never surfacing a raw 429 to the user.97- **Streamed tokens** — `streamCompletion()` yields `{ type, content }` events for98 SSE, with a terminal `done` or `error` event.99- **Metrics** — every call emits `{ model, latencyMs, tokens, cached }` to your100 metrics sink (Prometheus, Datadog, or `console.log` by default).101102## Error Handling103104| Issue | Cause | Solution |105|-------|-------|----------|106| 429 on primary model | RPM/TPM exceeded | Fall back to different model |107| High latency | Wrong model tier | Route to `8b-instant` for latency-critical paths |108| Context overflow | Input > 128K tokens | Truncate or chunk input |109| Vision errors | Wrong model for images | Use Llama 4 Scout full model path |110| `GROQ_API_KEY` undefined | Env var not exported | Export the key before starting the process |111112## Examples113114A latency-critical chat turn routes to the speed tier and returns one completion:115116```typescript117const model = selectModel({ maxLatencyMs: 80, costSensitive: true });118// → llama-3.1-8b-instant119const res = await completionWithMiddleware(groq, model.id, messages);120```121122Streaming a UI consumes the async generator token-by-token:123124```typescript125for await (const event of streamCompletion(groq, messages)) {126 if (event.type === "token") process.stdout.write(event.content!);127}128```129130Four fully worked examples — latency-critical, quality-with-fallback, streaming,131and vision routing — are in [references/examples.md](references/examples.md).132133## Resources134135- [Groq API Documentation](https://console.groq.com/docs)136- [Groq Models](https://console.groq.com/docs/models)137- [Groq Rate Limits](https://console.groq.com/docs/rate-limits)138- [Groq Pricing](https://groq.com/pricing)139140## Next Steps141142For multi-environment deployment, see the `groq-multi-env-setup` skill, which143extends this service layer with per-environment configuration and secrets handling.144145---146147**Source:** [`jeremylongshore/claude-code-plugins-plus-skills`](https://github.com/jeremylongshore/claude-code-plugins-plus-skills) → `plugins/saas-packs/groq-pack/skills/groq-reference-architecture/SKILL.md`