建立分享連結

透過 Agent 的 API Key 為該 Agent 創建一個分享連結，終端用戶打開連結即可直接與 Agent 對話。可設定連結有效期、最大用戶數、每個用戶的最大发送消息數、訪問密碼以及是否開啟反饋建議，效果與在「分享」頁面手動創建分享連結完全一致。

• 創建出的分享連結會同步出現在 Agent 的分享連結列表中，可在控制台查看用戶數與點數消耗，並繼續編輯或刪除。組織內擁有分享連結編輯 / 刪除權限的成員均可操作通過 API 創建的連結。
• 分享連結產生的點數消耗計入 Agent 所屬組織。
• 若組織已綁定自訂域名，返回的分享連結地址將使用自訂域名。
• 僅支持 Agent，使用 Workflow 的 API Key 調用將返回 Bot 類型不正確。
• 若當前站點未開放「分享」整合渠道，調用將返回操作不支持。

請求方式

POST

調用地址

https://api-${endpoint}.gptbots.ai/v1/agent/share/create

調用驗證

詳情參見 API 概述的鑑權方式說明。請使用目標 Agent 的 API Key 作為 token。

請求

請求示例

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/share/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
        "name": "官网试用链接",
        "valid_days": 7,
        "user_limit": 10,
        "user_question_limit": 9999,
        "password": "Vc3h",
        "feedback_enabled": true
}'

                    

所有參數均為選填，請求體傳 {} 時將創建一個永久有效、無需密碼、最多 10 個使用者、每使用者最多 9999 條訊息、未啟用反饋建議的分享連結。如需限制訪問，請顯式傳入 valid_days 與 password。

欄位名稱均為底線命名（snake_case）。請求體中出現無法識別的欄位（如寫成駝峰的 validDays）時，介面會返回 40000 並在錯誤資訊中列出這些欄位，不會創建連結。

請求標頭

請求參數

回應

回應示例

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "share_id": "66f8c2a1e4b0a93c5d7f1a20",
    "link": "https://www.gptbots.ai/s/csAbC123",
    "expire_time": 1760112000000
  }
}

                    

成功響應

失敗響應

錯誤碼