外觀
瓜瓜AI 介紹
瓜瓜AI 提供對外的 REST API,並以 OpenAI 相容的介面形式提供 Chat Completions(對話補全)能力:你可以沿用既有的 OpenAI SDK、工具鏈與客戶端,只要把 Base URL 指向瓜瓜AI 並改用瓜瓜AI 的 API Key。
本文件是瓜瓜AI 的官方使用與接入文檔,涵蓋從取得金鑰、發出第一個請求、串流輸出、客戶端設定,到常見錯誤排查的完整流程。
服務資訊一覽
| 項目 | 內容 |
|---|---|
| 文檔網址 | https://docs.api.guagua5487.xyz |
| API Base URL | https://api.guagua5487.xyz/v1 |
| 主要端點 | POST /v1/chat/completions(詳見 Chat Completions) |
| 驗證方式 | API Key,透過 Authorization: Bearer <API_KEY> 標頭傳遞 |
| 請求格式 | Content-Type: application/json |
| 回應格式 | JSON;啟用串流時為 SSE(text/event-stream) |
| 相容性 | OpenAI 相容介面,詳見 OpenAI 相容性 |
待補充
以下資訊尚未由官方確認,本文件不會自行推測,請以官方公告與服務端實際回應為準:
- 目前實際開放的模型代號與數量(見 支援模型)
- 是否開放
GET /v1/models等輔助端點(見 模型選擇) - 速率限制、併用上限、計費與價格方案(見 429 Too Many Requests)
- API Key 的申請與管理方式(見 快速開始)
這份文檔包含什麼
| 章節 | 內容 | 適合誰 |
|---|---|---|
| 快速開始 | 服務介紹、Base URL、第一個 API 請求 | 第一次接入的使用者 |
| API 文檔 | Chat Completions、串流輸出、模型選擇、OpenAI 相容性 | 開發者 |
| 客戶端教學 | Cherry Studio、OpenAI SDK、通用相容客戶端 | 想直接用現成工具的人 |
| 模型 | 支援模型、模型選擇指南 | 需要挑選模型的人 |
| 常見問題 | 400 / 401 / 403 / 429 / 5xx 錯誤排查 | 正在排錯的人 |
名詞對照
| 名詞 | 說明 |
|---|---|
| Base URL | 所有 API 路徑的共同前綴,瓜瓜AI 為 https://api.guagua5487.xyz/v1。 |
| API Key | 代表你身分的憑證,放在 Authorization 標頭中。請視為密碼保管。 |
| Endpoint | 具體的呼叫路徑,例如 /chat/completions。完整網址=Base URL + Endpoint。 |
| messages | 對話內容陣列,每筆包含 role(system / user / assistant / tool)與 content。 |
| model | 指定要使用的模型代號,字串格式。 |
| stream | 是否以 SSE 逐段回傳內容,而非一次回傳完整結果。 |
| Token | 模型處理文字的最小單位,通常用於估算用量與長度限制。 |
建議閱讀路徑
我要寫程式接入
- 快速開始 — 取得金鑰、確認 Base URL
- 第一個 API 請求 — 跑通最小可用請求
- Chat Completions — 完整參數與回應結構
- 串流輸出 — 需要即時輸出時
我要用現成客戶端(不寫程式)
我遇到錯誤
關於「待補充」標記
本文件在撰寫時,僅採用可確認的資訊。凡是尚未由官方確認的內容(模型名稱、限制、價格、錯誤碼細節、端點清單等),一律以「待補充」提示區塊標示,不會自行編造。
若你需要這些資訊,請以官方公告或服務端實際回應為準;若你有權限提供正確內容,歡迎直接補進對應頁面。
安全提醒
- 本文件所有範例只使用佔位字串(例如
YOUR_API_KEY、MODEL_ID),不含任何真實憑證。 - 請勿將 API Key 寫入前端程式碼、公開儲存庫或截圖中。
- 建議以環境變數保存金鑰,並定期輪替。