2. 創建密鑰

在菜單中找到API keys，并創建新的密鑰

填寫一個 API 密鑰的名稱并創建

在彈出的對話框中復制 API 密鑰，并妥善保存

3. 快速接入

1. 設置您的 API 密鑰

將您的 API 密鑰配置為環境變量。此方法無需在每個請求中包含 API 密鑰，從而簡化了 API 的使用。此外，它還通過最大限度地降低無意中將您的 API 密鑰包含在代碼庫中的風險來增強安全性。

在您選擇的終端中：

export GROQ_API_KEY=<your-api-key-here> // 填入上面創建的密鑰

2. 請求完成您的第一次聊天

安裝 Groq JavaScript 庫：

npm install --save groq-sdk

執行聊天完成：

import Groq from "groq-sdk";



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



export async function main() {

  const chatCompletion = await getGroqChatCompletion();

  // Print the completion returned by the LLM.

  console.log(chatCompletion.choices[0]?.message?.content || "");

}



export async function getGroqChatCompletion() {

  return groq.chat.completions.create({

    messages: [

      {

        role: "user",

        content: "Explain the importance of fast language models",

      },

    ],

    model: "llama3-8b-8192",

  });

}

4. API 錯誤代碼和響應

我們的 API 使用標準 HTTP 響應狀態代碼來指示 API 請求的成功或失敗。如果發生錯誤，響應正文將包含一個 JSON 對象，其中包含有關錯誤的詳細信息。以下是您可能遇到的錯誤代碼及其描述和示例響應正文。

錯誤代碼文檔

我們的 API 使用特定的錯誤代碼來指示 API 請求的成功或失敗。了解這些代碼及其含義對于有效地處理和調試錯誤至關重要。

成功代碼

• 200 OK：請求已成功執行。無需進一步操作。

客戶端錯誤代碼

• 400 錯誤請求：由于語法無效，服務器無法理解請求。檢查請求格式并確保其正確無誤。
• 401 未授權：請求未成功，因為它缺少所請求資源的有效身份驗證憑據。請確保請求包含必要的身份驗證憑據，并且 API 密鑰有效。
• 404 Not Found : 無法找到請求的資源。請檢查請求 URL 和資源是否存在。
• 422 無法處理的實體：請求格式正確，但由于語義錯誤而無法執行。請驗證所提供的數據的正確性和完整性。
• 429 請求過多: 在給定的時間段內發送了過多的請求。實施請求限制并遵守速率限制。

服務器錯誤代碼

• 500 內部服務器錯誤: 服務器發生一般錯誤。請稍后重試請求，如果問題仍然存在，請聯系支持人員。
• 502 Bad Gateway：服務器從上游服務器收到無效響應。這可能是暫時的問題；重試請求可能會解決問題。
• 503 服務不可用: 服務器尚未準備好處理請求，通常是由于維護或過載。請等待，然后再重試請求。

信息代碼

• 206 部分內容：僅交付部分資源，通常是對客戶端發送的范圍標頭的響應。請確保這是所發出請求的預期結果。

錯誤對象解釋

發生錯誤時，我們的 API 會返回一個結構化的錯誤對象，其中包含有關該問題的詳細信息。本節介紹錯誤對象的組成部分，以幫助進行故障排除和錯誤處理。

錯誤對象結構

錯誤對象遵循特定的結構，提供清晰且可操作的消息以及錯誤類型分類：

{

  "error": {

    "message": "String - description of the specific error",

    "type": "invalid_request_error"

  }

}

成分

• error（對象）：錯誤詳細信息的主要容器。
  • message(字符串)：解釋錯誤性質的描述性消息，旨在幫助開發人員診斷問題。
  • type(字符串)：錯誤類型的分類，例如"invalid_request_error"，表示遇到的問題的一般類別。

5. 常見問題

Q：如何找到GroqCloud API

A：冪簡集成是國內領先的API集成管理平臺，專注于為開發者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API：通過關鍵詞搜索API(例如，輸入’GroqCloud API ‘這類品類詞，更容易找到結果)、或者從API hub分類頁進入尋找。

Q：我希望在某某場景中使用到大模型，有沒有相應的Demo推薦查看？
A：您可以在開放平臺-體驗中心，體驗GroqCloud API的模型服務，目前開放平臺支持文本、語音兩種模型的體驗。

Q：我是微信小程序開發者，需要對接微信的相關資質信息。
A：請您發送郵件到open-platform@groqCloud.com 或掃描開放平臺底部企業微信二維碼聯系我們，備注“微信小程序”，我們將盡快為您提供服務。

Q：如何獲知GroqCloud API開放平臺的最新消息和模型通知？
A：請關注開放平臺-文檔中心-公告通知，了解開放平臺功能、接口和模型的最新動態。也可以關注開放平臺公眾號：GroqCloud API開放平臺，了解更GroqCloud API開放平臺信息。

Q：音色克隆服務如何對接？
A：目前音色克隆服務僅通過與銷售一對一溝通的方式提供，您可以在首頁填寫合作咨詢表單，我們的工作人員會盡快與您聯系。

Q：對于高并發數的情況，你們如何處理？

A：目前更多并發需要通過對應的客戶經理進行申請，如果您有更多的需要也可以通過郵件與我們進行溝通，我們的郵箱是：open-platform@GroqCloud.com。

Q：GroqCloud API的替代品有哪些？

提供AI大模型API的服務商除了GroqCloud API，還有其他替代服務商也提供類似api服務，例如：

360多模態大語言模型、語音大模型服務MiniMax-稀宇科技、通用大模型開放平臺-華藏、訊飛星火認知大模型

更多競品可以在冪簡集成開放平臺中找到。

Q：通義千問API這個密鑰還適用于哪些api？

語音生成、視頻生成、音樂生成

6.  總結

本文為開發者提供了詳盡的GroqCloud API密鑰獲取指南，涵蓋從賬號注冊、開發者認證到密鑰獲取的每一步流程，清晰明確。同時，強調了密鑰獲取后的測試環節，確保API順利集成至應用中，為開發者提供了一個全面實用的解決方案，助力其提升應用的交互性和功能性。