API Reference
依開發任務尋找 AGTCloud API，並檢視端點、參數、回應和線上測試。
AGTCloud API Reference 提供各 API 的請求位址、身分驗證方式、參數 Schema、回應結構、程式碼範例和線上測試。你可以先依任務找到 API，再進入特定端點頁面檢視完整欄位。
第一次呼叫 API
如果你還沒有 API Key，或尚未確認 Base URL 和模型 ID，請先閱讀快速開始。若已完成基礎設定，可以直接從下方選擇需要的 API。
主要功能
文字、圖片和影片是目前 API Reference 的主要入口。單一功能可能同時提供 OpenAI 相容格式、供應商格式或 AGTCloud 非同步任務格式，請依現有 SDK 和目標模型選擇。
文字與對話
使用 Chat Completions、Responses、Anthropic Messages、Gemini Generate Content 等協議生成文字並處理多輪對話。
圖片生成
建立、編輯或生成圖片變體，也可以使用 Grok Image 與 Midjourney 非同步任務 API。
影片生成
透過平台 Video Generations、OpenAI Videos，以及 Grok、Kling、Vidu 等入口建立和查詢影片。
更多 API
音訊處理
進行語音合成、音訊轉錄與翻譯、非同步語音辨識和音色處理。
Embeddings
將文字或 Token 輸入轉換為向量，用於語意檢索、分群和相似度計算。
Rerank
使用 Jina、Cohere 或 Xinference 格式，依相關性重新排序候選文件。
Realtime
透過 WebSocket 事件處理即時文字、音訊和函式呼叫。
依 API 型態選擇
不同功能使用的傳輸形式和結果取得方式並不相同。用戶端應依端點頁面標示的 Content-Type 和回應型別處理資料。
| API 型態 | 常見情境 | 用戶端處理方式 |
|---|---|---|
| 同步 JSON | 一般文字、Embedding、Rerank | 請求完成後解析 JSON 回應 |
| SSE 串流回應 | Chat、Responses、Gemini 串流生成 | 持續讀取事件，直到串流結束 |
| 非同步任務 | 影片、Midjourney | 儲存任務 ID，並查詢狀態和結果 |
| Multipart 上傳 | 圖片編輯、音訊轉錄 | 依端點要求上傳檔案和表單欄位 |
| 二進位回應 | 影片或音訊內容下載 | 依回應媒體型別儲存檔案 |
| WebSocket | Realtime | 建立長連線並持續收發事件 |
如何閱讀端點頁面
確認 Endpoint 和身分驗證
檢查 Method、Path、API 位址以及端點要求的驗證 Header。通用規則請參閱通用約定。
選擇請求情境
在請求範例中選擇最接近目前任務的情境，再依 Request Body、Path Parameters 或 Query Parameters 調整欄位。
使用 Try It 驗證
線上測試會使用本頁顯示的 API 位址。請填入目前帳戶的 API Key，並從模型清單中選擇可用模型。請勿在共用裝置上使用長期正式環境 Key。
串接前的共同規則
- 不確定要使用哪一種文字協議時，請先閱讀協議選擇。
- Reference 中的
MODEL_ID必須替換為目前 API Key 實際可用的模型 ID。 - 同名功能在不同模型和協議下可能支援不同欄位；請以目前端點、帳戶權限和實際回應為準。
- 正式環境的應用程式不得將 API Key 硬式編碼至瀏覽器前端或用戶端套件；Try It 僅供臨時測試，也不要將 Key 寫入公開程式碼儲存庫、截圖或日誌。
繼續閱讀：通用約定 · API Key、Base URL 與身分驗證