技能 编程开发 Groq SDK 安装与认证配置

Groq SDK 安装与认证配置

v20260423
groq-install-auth
本指南详细介绍了如何在Python和TypeScript环境中安装和配置Groq SDK。它涵盖了依赖安装、使用环境变量进行安全API密钥管理,并提供了连接验证代码示例。使用此流程可快速搭建与Groq超高速大模型推理API的连接,是所有基于Groq的项目起步必备步骤。
获取技能
326 次下载
概览

Groq Install & Auth

Overview

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/.

Prerequisites

  • Node.js 18+ or Python 3.8+
  • Package manager (npm, pnpm, or pip)
  • Groq account at console.groq.com
  • API key from GroqCloud console (Settings > API Keys)

Instructions

Step 1: Install the SDK

set -euo pipefail
# TypeScript / JavaScript
npm install groq-sdk

# Python
pip install groq

Step 2: Get Your API Key

  1. Go to console.groq.com/keys
  2. Click "Create API Key"
  3. Copy the key (starts with gsk_)
  4. Store it securely -- you cannot view it again

Step 3: Configure Environment

# 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

Step 4: Verify Connection (TypeScript)

import Groq from "groq-sdk";

const groq = new Groq({
  apiKey: process.env.GROQ_API_KEY,
});

async function verify() {
  const models = await groq.models.list();
  console.log("Connected! Available models:");
  for (const model of models.data) {
    console.log(`  ${model.id} (owned by ${model.owned_by})`);
  }
}

verify().catch(console.error);

Step 5: Verify Connection (Python)

import os
from groq import Groq

client = Groq(api_key=os.environ.get("GROQ_API_KEY"))

models = client.models.list()
print("Connected! Available models:")
for model in models.data:
    print(f"  {model.id} (owned by {model.owned_by})")

SDK Defaults

The Groq SDK auto-reads GROQ_API_KEY from environment if no apiKey is passed to the constructor. Additional constructor options:

const groq = new Groq({
  apiKey: process.env.GROQ_API_KEY,  // Optional if env var set
  baseURL: "https://api.groq.com/openai/v1",  // Default
  maxRetries: 2,      // Default retry count
  timeout: 60_000,    // 60 second timeout (ms)
});

API Key Formats

PrefixTypeUsage
gsk_Standard API keyAll API endpoints

Groq uses a single key type. There are no separate read/write scopes -- all keys have full API access. Restrict access through organizational controls in the console.

Error Handling

ErrorCauseSolution
401 Invalid API KeyKey missing, revoked, or mistypedVerify key at console.groq.com/keys
MODULE_NOT_FOUND groq-sdkSDK not installedRun npm install groq-sdk
ModuleNotFoundError: No module named 'groq'Python SDK missingRun pip install groq
ENOTFOUND api.groq.comNetwork/DNS issueCheck internet connectivity and firewall

.gitignore Template

# Groq secrets
.env
.env.local
.env.*.local

Resources

Next Steps

After successful auth, proceed to groq-hello-world for your first chat completion.

信息
分类 编程开发
名称 groq-install-auth
版本 v20260423
大小 3.8KB
更新时间 2026-04-28
语言