executing-plans
executing-plans
Use when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available
groq-install-authInstall and configure Groq SDK authentication for TypeScript or Python. Use when setting up a new Groq integration, configuring API keys, or initializing the groq-sdk in your project. Trigger with phrases like "install groq", "setup groq", "groq auth", "configure groq API key".
Independent GitHub snapshot · Automated classification · Original documentation governs
name: groq-install-auth description: 'Install and configure Groq SDK authentication for TypeScript or Python.
Use when setting up a new Groq integration, configuring API keys,
or initializing the groq-sdk in your project.
Trigger with phrases like "install groq", "setup groq",
"groq auth", "configure groq API key".
' allowed-tools: Bash(npm:), Bash(pip:), Bash(export:*) version: 1.11.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:
Install the official Groq SDK and configure API key authentication. Groq provides ultra-fast LLM inference on custom LPU hardware through an OpenAI-compatible REST API at api.groq.com/openai/v1/.
The workflow is four steps: install the SDK, mint an API key, export it as an
environment variable, and verify the connection by listing models. Each step is
summarized below; deep detail lives in references/.
set -euo pipefail
# TypeScript / JavaScript
npm install groq-sdk
# Python
pip install groq
gsk_)Add the .gitignore template
before writing any .env file so a key can never be committed:
# Set environment variable (recommended)
export GROQ_API_KEY="gsk_your_key_here"
# Or create .env file (add .env to .gitignore first)
echo 'GROQ_API_KEY=gsk_your_key_here' >> .env
Run a short script that lists the models your key can access — a successful list proves authentication end-to-end. The essential TypeScript skeleton:
import Groq from "groq-sdk";
const groq = new Groq({ apiKey: process.env.GROQ_API_KEY });
const models = await groq.models.list();
console.log(models.data.map((m) => m.id));
Full runnable TypeScript and Python verification scripts, with expected output: verification walkthrough.
A successful setup produces:
groq-sdk (Node) or groq (Python) installed in the project.GROQ_API_KEY available in the environment (or .env, with .env gitignored).Connected! Available models:
llama-3.3-70b-versatile (owned by Meta)
llama-3.1-8b-instant (owned by Meta)
If the verification run prints a 401 instead of a model list, authentication
failed — see Error Handling.
The SDK auto-reads GROQ_API_KEY from the environment when no apiKey is passed.
Groq uses a single gsk_ key type with full API access (no read/write scopes).
Constructor options (baseURL, maxRetries, timeout), the OpenAI-SDK
compatibility path, and the key-format table are in the
configuration reference.
| Error | Cause | Solution |
|---|---|---|
401 Invalid API Key | Key missing, revoked, or mistyped | Verify key at console.groq.com/keys |
MODULE_NOT_FOUND groq-sdk | SDK not installed | Run npm install groq-sdk |
ModuleNotFoundError: No module named 'groq' | Python SDK missing | Run pip install groq |
ENOTFOUND api.groq.com | Network/DNS issue | Check internet connectivity and firewall |
Extended diagnostics (checking the exported variable, .env loading, key
rotation): troubleshooting reference.
Example 1 — Node project from scratch:
npm install groq-sdk
export GROQ_API_KEY="gsk_your_key_here"
node --env-file=.env verify.mjs # lists models → auth confirmed
Example 2 — Python project:
pip install groq
export GROQ_API_KEY="gsk_your_key_here"
python verify.py # prints accessible models
Example 3 — reuse an existing OpenAI codebase: point the OpenAI SDK at Groq
by overriding baseURL to https://api.groq.com/openai/v1 and passing your
gsk_ key. See the configuration reference.
Complete, runnable versions of the verification scripts are in the verification walkthrough.
After successful auth, proceed to the groq-hello-world skill to run your first
chat completion. For SDK tuning (retries, timeouts, custom base URL), read the
configuration reference.