Create a Share Link

Create a share link for the Agent using the Agent's API Key. End users can open the link to directly interact with the Agent. You can set the link expiration, maximum number of users, maximum number of messages per user, access password, and whether to enable feedback suggestions. The effect is exactly the same as manually creating a share link on the "Share" page.

• The created share link will be synchronized to the Agent's share link list. You can check the number of users and credits consumed in the console, and continue to edit or delete it. Members in the organization with permission to edit/delete share links can operate links created via API.
• Credits consumed by the share link will be counted toward the organization to which the Agent belongs.
• If the organization has a custom domain bound, the returned share link address will use the custom domain.
• Only supports Agents; calling with a Workflow API Key will return an incorrect Bot type.
• If the current site does not have the "Share" integration channel enabled, the call will return that the operation is not supported.

Request Method

POST

Call URL

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

Call Authentication

For details, please refer to the authentication method description in API Overview. Use the target Agent's API Key as the token.

Request

Request Example

                      
                      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
}'

                    

All parameters are optional. When the request body passes {}, it will create a permanently valid, password-free share link for up to 10 users, with a maximum of 9999 messages per user, and feedback suggestions disabled. If access restrictions are needed, explicitly pass valid_days and password.

All field names use snake_case. If the request body contains unrecognized fields (e.g., written in camelCase like validDays), the API will return 40000 and list these fields in the error message, without creating the link.

Request Headers

Request Parameters

Response

Response Example

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

                    

Successful Response

Failed Response

Error Codes