创建分享链接

通过 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
  }
}

                    

成功响应

失败响应

错误码