概覽
概覽
Postman
Postman 是一款功能強大的工具，專為 API 的開發與測試而設計。您可以輕鬆建立、管理並測試 API。GPTBots 提供 Postman 集合，協助您快速進行 API 測試。
GPTBots Postman 集合
基本約束
GPTBots API 完全遵循 HTTP 與 REST 規範。查詢請求需使用 GET 方法，而提交請求則需使用 POST 方法。若請求未採用正確的 HTTP 方法，將會回傳錯誤訊息。
除非另有說明，參數值應以 UTF-8 編碼並進行 URL 編碼。
驗證方式
GPTBots REST API 採用 HTTP 基本驗證。請新增以下 Authorization 標頭：
Authorization: Bearer ${API_Key}
Authorization: Bearer ${API_Key}
此代碼塊在浮窗中顯示
API 啟用方式
- 若需啟用 API 服務，請進入 GPTBots 儀表板，點選「Agent Integration」，選擇「Development-API Service」，然後按下「Enable」按鈕以開啟 API 服務。
- 啟用 API 服務後，請點擊「API」卡片進入 API 管理頁面，再按下「Create API 金鑰」按鈕，即可產生可用於呼叫 GPTBots API 的 API 金鑰。
API 基本 URL
API URL 格式：
https://api-${端點}.gptbots.ai/
{端點} 代表您建立組織時選擇的資料中心。開發者應依據實際需求選擇適合的 {端點}。
資料中心列表
GPTBots 平台目前提供以下資料中心：
| 資料中心 | 端點 | API 基本 URL |
|---|---|---|
| 新加坡 | sg | https://api-sg.gptbots.ai/ |
| 日本 | jp | https://api-jp.gptbots.ai/ |
| 泰國 | th | https://api-th.gptbots.ai/ |
若開發者未於 API 請求 URL 中指定
-{端點}，則預設資料中心為新加坡。
所有 API 請求皆需包含正確的端點路徑。例如，若組織選用新加坡資料中心，API 請求 URL 應為：https://api-sg.gptbots.ai/v2/conversation
API 類別
GPTBots 平台提供多元化的 API 介面，以滿足開發者的各種業務需求。開發者可依據需求選擇適合的 API。API 類別如下：
| API 類別 | 說明 |
|---|---|
| Conversation API | 透過此 API 與 Agent 互動與對話。 |
| Workflow API | 透過此 API 發送請求並接收來自工作流程的回應。 |
| Knowledge API | 透過此 API 管理 GPTBots 平台上的知識庫。 |
| Database API | 透過此 API 管理 GPTBots 平台上的資料庫。 |
| Models API | 透過此 API 存取 GPTBots 平台的各項模型能力。 |
| User API | 透過此 API 設定用戶資訊、屬性與聯絡方式。 |
| Analytics API | 透過此 API 查詢信用額度與 Token 使用數據。 |
| Account API | 透過此 API 取得帳號下 Agent、組織等相關資訊。 |
API 使用限制
GPTBots 平台針對 API 呼叫設置使用限制，不同 API 類別有不同的限制。若超過限制，將會回傳超出使用限制的提示訊息。具體限制如下：
- 免費方案：所有 API 類型預設每分鐘最多 3 次請求。
- 企業自訂方案：請聯繫 GPTBots 業務代表，以取得專屬的 API 使用限制權限。