AGTCloud API Docs
文件指南API Reference整合與資源更新與幫助

SDK 概覽

按協議選擇 OpenAI、Anthropic 或 Gemini 用戶端 SDK,並完成串接前檢查。

AGTCloud 提供 OpenAI、Anthropic 和 Gemini 相容入口。已經使用相應原廠 SDK 的伺服器端專案,通常可以保留主要呼叫方式,並將 API 地址、API Key 和模型 ID 替換為 AGTCloud 設定。

SDK 只能按照其對應協議組織請求。選擇前請先確認目標模型支援的協議,不要僅根據模型名稱判斷相容性。

選擇用戶端 SDK

SDK對應協議身分驗證方式適合場景
OpenAI SDKChat Completions、ResponsesBearer API Key已有 OpenAI SDK 專案,或需要訊息對話、Typed Items、串流輸出和工具呼叫
Anthropic SDKAnthropic Messagesx-api-key 與版本 Header已有 Anthropic Messages 專案,或需要 Content Blocks 和 Anthropic 工具結構
Gemini SDKGemini Generate ContentBearer API Key已有 Gemini SDK 專案,或需要 contents、parts 和 Gemini 原生內容結構

SDK 不會自動轉換協議

OpenAI 的 messages 或 input、Anthropic 的 Content Blocks、Gemini 的 contents 和 parts 是不同的資料結構。請使用與現有業務程式碼一致的協議教學;如果需要跨協議重構,請先閱讀原廠 SDK 移轉。

三種協議的主要區別

對比項OpenAI SDKAnthropic SDKGemini SDK
主要入口Chat Completions、ResponsesMessagesGenerate Content
對話輸入messages 或 inputmessages 與 Content Blockscontents 與 parts
一般文字輸出Chat Message 或 Responses Output Itemscontent 內容區塊candidates[].content.parts
串流結構Chat Delta 或 response.* 事件Messages SSE 事件Stream Generate Content
工具結構Function Tools 與 Responses 內建工具tool_use、tool_resultfunctionCall、functionResponse

完整欄位、列舉和回應結構應以對應 API Reference 為準。SDK 教學重點說明用戶端安裝、初始化和結果讀取,不重複展開所有 Schema。

串接前準備

建立 API Key

前往 API Keys 頁面建立 AGTCloud API Key,並將它儲存在伺服器端環境變數或金鑰管理服務中。

不要把真實 API Key 寫進瀏覽器程式碼、行動裝置安裝套件、公開倉庫、截圖或記錄。

確認模型與協議

在模型廣場中複製完整模型 ID,並確認該模型支援準備使用的協議與能力。

本頻道統一使用 MODEL_ID 表示模型預留位置。實際呼叫前必須將其替換為目前 API Key 可見的模型 ID。

選擇伺服器端執行環境

Python 和 TypeScript SDK 都應執行在可信伺服器端環境中。安裝目前穩定版 SDK,並透過專案的相依性鎖定檔固定實際使用的版本。

建議的驗證順序

  1. 安裝 SDK 並確認應用程式能夠讀取 API Key。
  2. 設定教學給出的 Base URL,不填寫完整的業務端點路徑。
  3. 使用純文字和最少欄位傳送一次非串流請求。
  4. 檢查文字結果、結束狀態和 Token 用量。
  5. 再按業務需要驗證 Streaming、工具、多模態或結構化輸出。
  6. 為逾時、限流和伺服器端錯誤增加記錄與受控重試。

協議存在不代表模型支援所有能力

同一協議下的不同模型可能具有不同的輸入模態、工具、結構化輸出和串流能力。請求出現欄位不支援或模型不可用時,請先核對模型資訊和對應 API Reference。

下一步

本頁目錄